From 1665e72c5d74df0ff0bb84367c1281d8dfd26277 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Wed, 15 Oct 2025 15:11:54 +0000 Subject: [PATCH 01/10] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.1.0 --- auto-generated-sdk/.openapi-generator/FILES | 172 +--- auto-generated-sdk/README.md | 121 +-- auto-generated-sdk/docs/AccountDirectories.md | 1 + auto-generated-sdk/docs/CalculationStatus.md | 1 + .../docs/CalculationStatusMeta.md | 3 +- .../docs/CalculationUnitStatus.md | 1 + .../docs/CalculationUnitStatusMeta.md | 1 + auto-generated-sdk/docs/Column.md | 14 - auto-generated-sdk/docs/ColumnStatistic.md | 11 - .../docs/ColumnStatisticRoot.md | 12 - .../docs/ColumnStatisticsApi.md | 95 -- auto-generated-sdk/docs/ColumnSummary.md | 14 - auto-generated-sdk/docs/ColumnsApi.md | 197 ---- auto-generated-sdk/docs/ComponentsApi.md | 190 +--- auto-generated-sdk/docs/ConfigurationsApi.md | 4 +- auto-generated-sdk/docs/Currency.md | 1 + auto-generated-sdk/docs/DatesApi.md | 108 --- auto-generated-sdk/docs/DocumentsApi.md | 93 -- auto-generated-sdk/docs/FICalculationsApi.md | 18 +- .../docs/FIConvertibleSettings.md | 16 + auto-generated-sdk/docs/FISecurity.md | 1 + auto-generated-sdk/docs/FPOAccount.md | 13 - auto-generated-sdk/docs/FPOObjective.md | 12 - .../docs/FPOOptimizationParameters.md | 14 - .../docs/FPOOptimizationParametersRoot.md | 12 - auto-generated-sdk/docs/FPOOptimizerApi.md | 708 -------------- .../docs/FPOOptimizerStrategy.md | 12 - .../docs/FPOOptimizerStrategyOverrides.md | 14 - auto-generated-sdk/docs/FrequenciesApi.md | 86 -- auto-generated-sdk/docs/Group.md | 13 - auto-generated-sdk/docs/GroupRoot.md | 12 - auto-generated-sdk/docs/GroupsApi.md | 181 ---- auto-generated-sdk/docs/LinkedPATemplate.md | 17 - .../docs/LinkedPATemplateParameters.md | 14 - .../docs/LinkedPATemplateParametersRoot.md | 12 - .../docs/LinkedPATemplatePostSummary.md | 14 - .../docs/LinkedPATemplatePostSummaryRoot.md | 12 - .../docs/LinkedPATemplateRoot.md | 12 - .../docs/LinkedPATemplateSummary.md | 13 - .../docs/LinkedPATemplateSummaryRoot.md | 12 - .../docs/LinkedPATemplateUpdateParameters.md | 13 - .../LinkedPATemplateUpdateParametersRoot.md | 12 - .../docs/LinkedPATemplatesApi.md | 516 ---------- .../docs/PACalculationColumn.md | 12 - .../docs/PACalculationDataSources.md | 13 - auto-generated-sdk/docs/PACalculationGroup.md | 12 - .../docs/PACalculationParameters.md | 19 - .../docs/PACalculationParametersRoot.md | 12 - .../docs/PACalculationPricingSource.md | 11 - auto-generated-sdk/docs/PACalculationsApi.md | 799 --------------- auto-generated-sdk/docs/PAComponent.md | 19 - auto-generated-sdk/docs/PAComponentData.md | 18 - auto-generated-sdk/docs/PAComponentRoot.md | 12 - auto-generated-sdk/docs/PADateParameters.md | 14 - auto-generated-sdk/docs/PAIdentifier.md | 12 - auto-generated-sdk/docs/PAPricingSource.md | 13 - .../docs/PAPricingSourceRoot.md | 12 - auto-generated-sdk/docs/PaDoc.md | 11 - auto-generated-sdk/docs/PubCalculationsApi.md | 24 +- .../docs/QuantCalculationsApi.md | 2 +- .../docs/QuantDateListObsolete.md | 14 - .../docs/QuantFdsDateObsolete.md | 15 - .../docs/QuantFqlExpressionObsolete.md | 14 - .../docs/QuantIdentifierUniverseObsolete.md | 13 - .../docs/QuantScreeningExpressionObsolete.md | 13 - ...uantScreeningExpressionUniverseObsolete.md | 14 - .../QuantUniversalScreenParameterObsolete.md | 12 - .../QuantUniversalScreenUniverseObsolete.md | 12 - .../docs/SPARCalculationsApi.md | 4 +- auto-generated-sdk/docs/SPARDateParameters.md | 1 + .../docs/StrategyDocumentsApi.md | 93 -- .../docs/TemplateContentTypes.md | 13 - .../docs/TemplatedPAComponent.md | 18 - .../docs/TemplatedPAComponentParameters.md | 14 - .../TemplatedPAComponentParametersRoot.md | 12 - .../docs/TemplatedPAComponentPostSummary.md | 15 - .../TemplatedPAComponentPostSummaryRoot.md | 12 - .../docs/TemplatedPAComponentRoot.md | 12 - .../docs/TemplatedPAComponentSummary.md | 14 - .../docs/TemplatedPAComponentSummaryRoot.md | 12 - .../TemplatedPAComponentUpdateParameters.md | 13 - ...emplatedPAComponentUpdateParametersRoot.md | 12 - .../docs/TemplatedPAComponentsApi.md | 584 ----------- auto-generated-sdk/docs/UnlinkedPATemplate.md | 26 - .../docs/UnlinkedPATemplateCategoryAndType.md | 12 - ...nlinkedPATemplateCategoryAndTypeDetails.md | 16 - ...kedPATemplateCategoryAndTypeDetailsRoot.md | 12 - .../UnlinkedPATemplateCategoryAndTypeRoot.md | 12 - .../docs/UnlinkedPATemplateColumnDetails.md | 13 - .../docs/UnlinkedPATemplateGroupDetails.md | 13 - .../docs/UnlinkedPATemplateParameters.md | 22 - .../docs/UnlinkedPATemplateParametersRoot.md | 12 - .../docs/UnlinkedPATemplatePostSummary.md | 14 - .../docs/UnlinkedPATemplatePostSummaryRoot.md | 12 - .../docs/UnlinkedPATemplateRoot.md | 12 - .../docs/UnlinkedPATemplateSummary.md | 13 - .../docs/UnlinkedPATemplateSummaryRoot.md | 12 - .../UnlinkedPATemplateUpdateParameters.md | 20 - .../UnlinkedPATemplateUpdateParametersRoot.md | 12 - .../docs/UnlinkedPATemplatesApi.md | 782 --------------- ...cesApi.md => VaultAttributionLoaderApi.md} | 53 +- ...t.md => VaultAttributionLoaderResponse.md} | 7 +- ... => VaultAttributionLoaderResponseRoot.md} | 4 +- .../docs/VaultCalculationsApi.md | 2 +- .../fds/analyticsapi/engines/__init__.py | 2 +- .../analyticsapi/engines/api/columns_api.py | 286 ------ .../engines/api/components_api.py | 241 ----- .../fds/analyticsapi/engines/api/dates_api.py | 146 --- .../analyticsapi/engines/api/documents_api.py | 120 --- .../engines/api/fi_calculations_api.py | 4 +- .../engines/api/fpo_optimizer_api.py | 795 --------------- .../engines/api/frequencies_api.py | 108 --- .../analyticsapi/engines/api/groups_api.py | 255 ----- .../engines/api/linked_pa_templates_api.py | 663 ------------- .../engines/api/pa_calculations_api.py | 917 ------------------ .../engines/api/pricing_sources_api.py | 165 ---- .../engines/api/pub_calculations_api.py | 23 +- .../engines/api/quant_calculations_api.py | 4 +- .../engines/api/spar_calculations_api.py | 4 +- .../engines/api/strategy_documents_api.py | 120 --- .../api/templated_pa_components_api.py | 659 ------------- .../engines/api/unlinked_pa_templates_api.py | 885 ----------------- ...api.py => vault_attribution_loader_api.py} | 52 +- .../engines/api/vault_calculations_api.py | 4 +- .../fds/analyticsapi/engines/api_client.py | 2 +- .../fds/analyticsapi/engines/apis/__init__.py | 10 +- .../fds/analyticsapi/engines/configuration.py | 2 +- .../engines/model/calculation_status_meta.py | 2 +- .../analyticsapi/engines/model/column_root.py | 178 ---- .../engines/model/column_statistic.py | 167 ---- .../engines/model/column_statistic_root.py | 178 ---- .../engines/model/column_summary.py | 173 ---- .../engines/model/column_summary_root.py | 178 ---- .../{column.py => fi_convertible_settings.py} | 39 +- .../analyticsapi/engines/model/fi_security.py | 5 + .../analyticsapi/engines/model/fpo_account.py | 183 ---- .../engines/model/fpo_objective.py | 174 ---- .../model/fpo_optimization_parameters.py | 191 ---- .../model/fpo_optimization_parameters_root.py | 175 ---- .../engines/model/fpo_optimizer_strategy.py | 178 ---- .../model/fpo_optimizer_strategy_overrides.py | 185 ---- .../analyticsapi/engines/model/group_root.py | 178 ---- .../engines/model/linked_pa_template.py | 190 ---- .../model/linked_pa_template_parameters.py | 185 ---- .../linked_pa_template_parameters_root.py | 178 ---- .../model/linked_pa_template_post_summary.py | 176 ---- .../linked_pa_template_post_summary_root.py | 178 ---- .../engines/model/linked_pa_template_root.py | 178 ---- .../model/linked_pa_template_summary.py | 173 ---- .../model/linked_pa_template_summary_root.py | 178 ---- .../linked_pa_template_update_parameters.py | 178 ---- ...nked_pa_template_update_parameters_root.py | 178 ---- .../engines/model/pa_calculation_column.py | 170 ---- .../model/pa_calculation_data_sources.py | 178 ---- .../engines/model/pa_calculation_group.py | 170 ---- .../model/pa_calculation_parameters.py | 207 ---- .../model/pa_calculation_parameters_root.py | 177 ---- .../model/pa_calculation_pricing_source.py | 167 ---- .../engines/model/pa_component.py | 198 ---- .../engines/model/pa_component_data.py | 201 ---- .../engines/model/pa_component_root.py | 178 ---- .../engines/model/pa_date_parameters.py | 177 ---- .../fds/analyticsapi/engines/model/pa_doc.py | 170 ---- .../engines/model/pa_identifier.py | 173 ---- .../engines/model/pa_pricing_source.py | 173 ---- .../engines/model/pa_pricing_source_root.py | 178 ---- .../engines/model/quant_date_list_obsolete.py | 180 ---- .../engines/model/quant_fds_date_obsolete.py | 185 ---- .../model/quant_fql_expression_obsolete.py | 180 ---- .../quant_identifier_universe_obsolete.py | 186 ---- .../quant_screening_expression_obsolete.py | 177 ---- ..._screening_expression_universe_obsolete.py | 189 ---- ...ant_universal_screen_parameter_obsolete.py | 174 ---- ...uant_universal_screen_universe_obsolete.py | 178 ---- .../engines/model/spar_date_parameters.py | 3 + .../engines/model/template_content_types.py | 173 ---- .../engines/model/templated_pa_component.py | 193 ---- .../templated_pa_component_parameters.py | 185 ---- .../templated_pa_component_post_summary.py | 179 ---- ...emplated_pa_component_post_summary_root.py | 178 ---- .../model/templated_pa_component_root.py | 178 ---- .../model/templated_pa_component_summary.py | 176 ---- .../templated_pa_component_summary_root.py | 178 ---- ...emplated_pa_component_update_parameters.py | 178 ---- ...ted_pa_component_update_parameters_root.py | 178 ---- .../engines/model/unlinked_pa_template.py | 227 ----- .../unlinked_pa_template_category_and_type.py | 170 ---- ...d_pa_template_category_and_type_details.py | 189 ---- ...template_category_and_type_details_root.py | 178 ---- ...nked_pa_template_category_and_type_root.py | 178 ---- .../unlinked_pa_template_column_details.py | 173 ---- .../unlinked_pa_template_group_details.py | 173 ---- .../model/unlinked_pa_template_parameters.py | 219 ----- .../unlinked_pa_template_parameters_root.py | 178 ---- .../unlinked_pa_template_post_summary.py | 176 ---- .../unlinked_pa_template_post_summary_root.py | 178 ---- .../model/unlinked_pa_template_root.py | 178 ---- .../model/unlinked_pa_template_summary.py | 173 ---- .../unlinked_pa_template_summary_root.py | 178 ---- .../unlinked_pa_template_update_parameters.py | 209 ---- ...nked_pa_template_update_parameters_root.py | 178 ---- ...y => vault_attribution_loader_response.py} | 22 +- ...vault_attribution_loader_response_root.py} | 12 +- .../analyticsapi/engines/models/__init__.py | 76 +- auto-generated-sdk/setup.py | 2 +- 205 files changed, 223 insertions(+), 23882 deletions(-) delete mode 100644 auto-generated-sdk/docs/Column.md delete mode 100644 auto-generated-sdk/docs/ColumnStatistic.md delete mode 100644 auto-generated-sdk/docs/ColumnStatisticRoot.md delete mode 100644 auto-generated-sdk/docs/ColumnStatisticsApi.md delete mode 100644 auto-generated-sdk/docs/ColumnSummary.md delete mode 100644 auto-generated-sdk/docs/ColumnsApi.md create mode 100644 auto-generated-sdk/docs/FIConvertibleSettings.md delete mode 100644 auto-generated-sdk/docs/FPOAccount.md delete mode 100644 auto-generated-sdk/docs/FPOObjective.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizationParameters.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizationParametersRoot.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizerApi.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizerStrategy.md delete mode 100644 auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md delete mode 100644 auto-generated-sdk/docs/Group.md delete mode 100644 auto-generated-sdk/docs/GroupRoot.md delete mode 100644 auto-generated-sdk/docs/GroupsApi.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplate.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateParameters.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplatePostSummary.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateSummary.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/LinkedPATemplatesApi.md delete mode 100644 auto-generated-sdk/docs/PACalculationColumn.md delete mode 100644 auto-generated-sdk/docs/PACalculationDataSources.md delete mode 100644 auto-generated-sdk/docs/PACalculationGroup.md delete mode 100644 auto-generated-sdk/docs/PACalculationParameters.md delete mode 100644 auto-generated-sdk/docs/PACalculationParametersRoot.md delete mode 100644 auto-generated-sdk/docs/PACalculationPricingSource.md delete mode 100644 auto-generated-sdk/docs/PACalculationsApi.md delete mode 100644 auto-generated-sdk/docs/PAComponent.md delete mode 100644 auto-generated-sdk/docs/PAComponentData.md delete mode 100644 auto-generated-sdk/docs/PAComponentRoot.md delete mode 100644 auto-generated-sdk/docs/PADateParameters.md delete mode 100644 auto-generated-sdk/docs/PAIdentifier.md delete mode 100644 auto-generated-sdk/docs/PAPricingSource.md delete mode 100644 auto-generated-sdk/docs/PAPricingSourceRoot.md delete mode 100644 auto-generated-sdk/docs/PaDoc.md delete mode 100644 auto-generated-sdk/docs/QuantDateListObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantFdsDateObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantFqlExpressionObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md delete mode 100644 auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md delete mode 100644 auto-generated-sdk/docs/TemplateContentTypes.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponent.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentParameters.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentSummary.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/TemplatedPAComponentsApi.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplate.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateParameters.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateSummary.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md delete mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatesApi.md rename auto-generated-sdk/docs/{PricingSourcesApi.md => VaultAttributionLoaderApi.md} (55%) rename auto-generated-sdk/docs/{ColumnRoot.md => VaultAttributionLoaderResponse.md} (60%) rename auto-generated-sdk/docs/{ColumnSummaryRoot.md => VaultAttributionLoaderResponseRoot.md} (74%) delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py rename auto-generated-sdk/fds/analyticsapi/engines/api/{column_statistics_api.py => vault_attribution_loader_api.py} (71%) delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_summary.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_summary_root.py rename auto-generated-sdk/fds/analyticsapi/engines/model/{column.py => fi_convertible_settings.py} (79%) delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_account.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_objective.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/group_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_column.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_data_sources.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_group.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_pricing_source.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_component.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_data.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_date_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_doc.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_identifier.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_date_list_obsolete.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_fds_date_obsolete.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/template_content_types.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py rename auto-generated-sdk/fds/analyticsapi/engines/model/{group.py => vault_attribution_loader_response.py} (91%) rename auto-generated-sdk/fds/analyticsapi/engines/model/{templated_pa_component_parameters_root.py => vault_attribution_loader_response_root.py} (94%) diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index 7f8d455e..c2aab057 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -35,14 +35,6 @@ docs/CalculationUnitStatusMeta.md docs/CalculationsSummary.md docs/CalculationsSummaryRoot.md docs/ClientErrorResponse.md -docs/Column.md -docs/ColumnRoot.md -docs/ColumnStatistic.md -docs/ColumnStatisticRoot.md -docs/ColumnStatisticsApi.md -docs/ColumnSummary.md -docs/ColumnSummaryRoot.md -docs/ColumnsApi.md docs/ComponentSummary.md docs/ComponentSummaryRoot.md docs/ComponentsApi.md @@ -76,6 +68,7 @@ docs/FICalculationParameters.md docs/FICalculationParametersRoot.md docs/FICalculationsApi.md docs/FICashflows.md +docs/FIConvertibleSettings.md docs/FIDiscountCurveInfo.md docs/FIDiscountCurveInfoRoot.md docs/FIJobSettings.md @@ -92,30 +85,9 @@ docs/FIServicerAdvances.md docs/FIServicerAdvancesForSecurities.md docs/FIStructuredProductsForJobSettings.md docs/FIStructuredProductsForSecurities.md -docs/FPOAccount.md -docs/FPOObjective.md -docs/FPOOptimizationParameters.md -docs/FPOOptimizationParametersRoot.md -docs/FPOOptimizerApi.md -docs/FPOOptimizerStrategy.md -docs/FPOOptimizerStrategyOverrides.md docs/FrequenciesApi.md docs/Frequency.md docs/FrequencyRoot.md -docs/Group.md -docs/GroupRoot.md -docs/GroupsApi.md -docs/LinkedPATemplate.md -docs/LinkedPATemplateParameters.md -docs/LinkedPATemplateParametersRoot.md -docs/LinkedPATemplatePostSummary.md -docs/LinkedPATemplatePostSummaryRoot.md -docs/LinkedPATemplateRoot.md -docs/LinkedPATemplateSummary.md -docs/LinkedPATemplateSummaryRoot.md -docs/LinkedPATemplateUpdateParameters.md -docs/LinkedPATemplateUpdateParametersRoot.md -docs/LinkedPATemplatesApi.md docs/NPOOptimizationParameters.md docs/NPOOptimizationParametersRoot.md docs/NPOOptimizerApi.md @@ -129,24 +101,8 @@ docs/OptimizerAccountOverrides.md docs/OptimizerOptimalHoldings.md docs/OptimizerOutputTypes.md docs/OptimizerTradesList.md -docs/PACalculationColumn.md -docs/PACalculationDataSources.md -docs/PACalculationGroup.md -docs/PACalculationParameters.md -docs/PACalculationParametersRoot.md -docs/PACalculationPricingSource.md -docs/PACalculationsApi.md -docs/PAComponent.md -docs/PAComponentData.md -docs/PAComponentRoot.md -docs/PADateParameters.md -docs/PAIdentifier.md -docs/PAPricingSource.md -docs/PAPricingSourceRoot.md -docs/PaDoc.md docs/PaginationInfo.md docs/PaginationMeta.md -docs/PricingSourcesApi.md docs/PubCalculationParameters.md docs/PubCalculationParametersRoot.md docs/PubCalculationsApi.md @@ -159,22 +115,14 @@ docs/QuantCalculationParametersRoot.md docs/QuantCalculationsApi.md docs/QuantDate.md docs/QuantDateList.md -docs/QuantDateListObsolete.md docs/QuantFdsDate.md -docs/QuantFdsDateObsolete.md docs/QuantFormula.md docs/QuantFqlExpression.md -docs/QuantFqlExpressionObsolete.md docs/QuantIdentifierUniverse.md -docs/QuantIdentifierUniverseObsolete.md docs/QuantScreeningExpression.md -docs/QuantScreeningExpressionObsolete.md docs/QuantScreeningExpressionUniverse.md -docs/QuantScreeningExpressionUniverseObsolete.md docs/QuantUniversalScreenParameter.md -docs/QuantUniversalScreenParameterObsolete.md docs/QuantUniversalScreenUniverse.md -docs/QuantUniversalScreenUniverseObsolete.md docs/QuantUniverse.md docs/ReturnType.md docs/SPARAccounts.md @@ -189,35 +137,9 @@ docs/SPARComponentRoot.md docs/SPARDateParameters.md docs/SPARIdentifier.md docs/StrategyDocumentsApi.md -docs/TemplateContentTypes.md -docs/TemplatedPAComponent.md -docs/TemplatedPAComponentParameters.md -docs/TemplatedPAComponentParametersRoot.md -docs/TemplatedPAComponentPostSummary.md -docs/TemplatedPAComponentPostSummaryRoot.md -docs/TemplatedPAComponentRoot.md -docs/TemplatedPAComponentSummary.md -docs/TemplatedPAComponentSummaryRoot.md -docs/TemplatedPAComponentUpdateParameters.md -docs/TemplatedPAComponentUpdateParametersRoot.md -docs/TemplatedPAComponentsApi.md -docs/UnlinkedPATemplate.md -docs/UnlinkedPATemplateCategoryAndType.md -docs/UnlinkedPATemplateCategoryAndTypeDetails.md -docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md -docs/UnlinkedPATemplateCategoryAndTypeRoot.md -docs/UnlinkedPATemplateColumnDetails.md -docs/UnlinkedPATemplateGroupDetails.md -docs/UnlinkedPATemplateParameters.md -docs/UnlinkedPATemplateParametersRoot.md -docs/UnlinkedPATemplatePostSummary.md -docs/UnlinkedPATemplatePostSummaryRoot.md -docs/UnlinkedPATemplateRoot.md -docs/UnlinkedPATemplateSummary.md -docs/UnlinkedPATemplateSummaryRoot.md -docs/UnlinkedPATemplateUpdateParameters.md -docs/UnlinkedPATemplateUpdateParametersRoot.md -docs/UnlinkedPATemplatesApi.md +docs/VaultAttributionLoaderApi.md +docs/VaultAttributionLoaderResponse.md +docs/VaultAttributionLoaderResponseRoot.md docs/VaultCalculationParameters.md docs/VaultCalculationParametersRoot.md docs/VaultCalculationsApi.md @@ -238,8 +160,6 @@ fds/analyticsapi/engines/api/afi_optimizer_api.py fds/analyticsapi/engines/api/axp_optimizer_api.py fds/analyticsapi/engines/api/benchmarks_api.py fds/analyticsapi/engines/api/bpm_optimizer_api.py -fds/analyticsapi/engines/api/column_statistics_api.py -fds/analyticsapi/engines/api/columns_api.py fds/analyticsapi/engines/api/components_api.py fds/analyticsapi/engines/api/configurations_api.py fds/analyticsapi/engines/api/currencies_api.py @@ -248,19 +168,13 @@ fds/analyticsapi/engines/api/discount_curves_api.py fds/analyticsapi/engines/api/documents_api.py fds/analyticsapi/engines/api/fi_calculations_api.py fds/analyticsapi/engines/api/fiab_calculations_api.py -fds/analyticsapi/engines/api/fpo_optimizer_api.py fds/analyticsapi/engines/api/frequencies_api.py -fds/analyticsapi/engines/api/groups_api.py -fds/analyticsapi/engines/api/linked_pa_templates_api.py fds/analyticsapi/engines/api/npo_optimizer_api.py -fds/analyticsapi/engines/api/pa_calculations_api.py -fds/analyticsapi/engines/api/pricing_sources_api.py fds/analyticsapi/engines/api/pub_calculations_api.py fds/analyticsapi/engines/api/quant_calculations_api.py fds/analyticsapi/engines/api/spar_calculations_api.py fds/analyticsapi/engines/api/strategy_documents_api.py -fds/analyticsapi/engines/api/templated_pa_components_api.py -fds/analyticsapi/engines/api/unlinked_pa_templates_api.py +fds/analyticsapi/engines/api/vault_attribution_loader_api.py fds/analyticsapi/engines/api/vault_calculations_api.py fds/analyticsapi/engines/api_client.py fds/analyticsapi/engines/apis/__init__.py @@ -294,12 +208,6 @@ fds/analyticsapi/engines/model/calculation_unit_status_meta.py fds/analyticsapi/engines/model/calculations_summary.py fds/analyticsapi/engines/model/calculations_summary_root.py fds/analyticsapi/engines/model/client_error_response.py -fds/analyticsapi/engines/model/column.py -fds/analyticsapi/engines/model/column_root.py -fds/analyticsapi/engines/model/column_statistic.py -fds/analyticsapi/engines/model/column_statistic_root.py -fds/analyticsapi/engines/model/column_summary.py -fds/analyticsapi/engines/model/column_summary_root.py fds/analyticsapi/engines/model/component_summary.py fds/analyticsapi/engines/model/component_summary_root.py fds/analyticsapi/engines/model/configuration_account.py @@ -320,6 +228,7 @@ fds/analyticsapi/engines/model/fi_bank_loans.py fds/analyticsapi/engines/model/fi_calculation_parameters.py fds/analyticsapi/engines/model/fi_calculation_parameters_root.py fds/analyticsapi/engines/model/fi_cashflows.py +fds/analyticsapi/engines/model/fi_convertible_settings.py fds/analyticsapi/engines/model/fi_discount_curve_info.py fds/analyticsapi/engines/model/fi_discount_curve_info_root.py fds/analyticsapi/engines/model/fi_job_settings.py @@ -341,26 +250,8 @@ fds/analyticsapi/engines/model/fiab_calculation_status.py fds/analyticsapi/engines/model/fiab_calculation_status_summary.py fds/analyticsapi/engines/model/fiab_date_parameters.py fds/analyticsapi/engines/model/fiab_identifier.py -fds/analyticsapi/engines/model/fpo_account.py -fds/analyticsapi/engines/model/fpo_objective.py -fds/analyticsapi/engines/model/fpo_optimization_parameters.py -fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py -fds/analyticsapi/engines/model/fpo_optimizer_strategy.py -fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py fds/analyticsapi/engines/model/frequency.py fds/analyticsapi/engines/model/frequency_root.py -fds/analyticsapi/engines/model/group.py -fds/analyticsapi/engines/model/group_root.py -fds/analyticsapi/engines/model/linked_pa_template.py -fds/analyticsapi/engines/model/linked_pa_template_parameters.py -fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py -fds/analyticsapi/engines/model/linked_pa_template_post_summary.py -fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py -fds/analyticsapi/engines/model/linked_pa_template_root.py -fds/analyticsapi/engines/model/linked_pa_template_summary.py -fds/analyticsapi/engines/model/linked_pa_template_summary_root.py -fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py -fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py fds/analyticsapi/engines/model/npo_optimization_parameters.py fds/analyticsapi/engines/model/npo_optimization_parameters_root.py fds/analyticsapi/engines/model/npo_optimizer_strategy.py @@ -373,20 +264,6 @@ fds/analyticsapi/engines/model/optimizer_account_overrides.py fds/analyticsapi/engines/model/optimizer_optimal_holdings.py fds/analyticsapi/engines/model/optimizer_output_types.py fds/analyticsapi/engines/model/optimizer_trades_list.py -fds/analyticsapi/engines/model/pa_calculation_column.py -fds/analyticsapi/engines/model/pa_calculation_data_sources.py -fds/analyticsapi/engines/model/pa_calculation_group.py -fds/analyticsapi/engines/model/pa_calculation_parameters.py -fds/analyticsapi/engines/model/pa_calculation_parameters_root.py -fds/analyticsapi/engines/model/pa_calculation_pricing_source.py -fds/analyticsapi/engines/model/pa_component.py -fds/analyticsapi/engines/model/pa_component_data.py -fds/analyticsapi/engines/model/pa_component_root.py -fds/analyticsapi/engines/model/pa_date_parameters.py -fds/analyticsapi/engines/model/pa_doc.py -fds/analyticsapi/engines/model/pa_identifier.py -fds/analyticsapi/engines/model/pa_pricing_source.py -fds/analyticsapi/engines/model/pa_pricing_source_root.py fds/analyticsapi/engines/model/pagination_info.py fds/analyticsapi/engines/model/pagination_meta.py fds/analyticsapi/engines/model/pub_calculation_parameters.py @@ -399,22 +276,14 @@ fds/analyticsapi/engines/model/quant_calculation_parameters.py fds/analyticsapi/engines/model/quant_calculation_parameters_root.py fds/analyticsapi/engines/model/quant_date.py fds/analyticsapi/engines/model/quant_date_list.py -fds/analyticsapi/engines/model/quant_date_list_obsolete.py fds/analyticsapi/engines/model/quant_fds_date.py -fds/analyticsapi/engines/model/quant_fds_date_obsolete.py fds/analyticsapi/engines/model/quant_formula.py fds/analyticsapi/engines/model/quant_fql_expression.py -fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py fds/analyticsapi/engines/model/quant_identifier_universe.py -fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py fds/analyticsapi/engines/model/quant_screening_expression.py -fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py fds/analyticsapi/engines/model/quant_screening_expression_universe.py -fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py fds/analyticsapi/engines/model/quant_universal_screen_parameter.py -fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py fds/analyticsapi/engines/model/quant_universal_screen_universe.py -fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py fds/analyticsapi/engines/model/quant_universe.py fds/analyticsapi/engines/model/return_type.py fds/analyticsapi/engines/model/spar_accounts.py @@ -427,33 +296,8 @@ fds/analyticsapi/engines/model/spar_component.py fds/analyticsapi/engines/model/spar_component_root.py fds/analyticsapi/engines/model/spar_date_parameters.py fds/analyticsapi/engines/model/spar_identifier.py -fds/analyticsapi/engines/model/template_content_types.py -fds/analyticsapi/engines/model/templated_pa_component.py -fds/analyticsapi/engines/model/templated_pa_component_parameters.py -fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py -fds/analyticsapi/engines/model/templated_pa_component_post_summary.py -fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py -fds/analyticsapi/engines/model/templated_pa_component_root.py -fds/analyticsapi/engines/model/templated_pa_component_summary.py -fds/analyticsapi/engines/model/templated_pa_component_summary_root.py -fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py -fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py -fds/analyticsapi/engines/model/unlinked_pa_template.py -fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py -fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py -fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py -fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py -fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py -fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py -fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py -fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py -fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py -fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py -fds/analyticsapi/engines/model/unlinked_pa_template_root.py -fds/analyticsapi/engines/model/unlinked_pa_template_summary.py -fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py -fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py -fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py +fds/analyticsapi/engines/model/vault_attribution_loader_response.py +fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py fds/analyticsapi/engines/model/vault_calculation_parameters.py fds/analyticsapi/engines/model/vault_calculation_parameters_root.py fds/analyticsapi/engines/model/vault_component.py diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index 74d26217..d6157ee0 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -4,7 +4,7 @@ Allow clients to fetch Analytics through APIs. This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] -- Package version: 6.0.0 +- Package version: 6.1.0-rc.1 - Build package: CustomPythonClientCodegen For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact) @@ -118,11 +118,6 @@ Class | Method | HTTP request | Description *BPMOptimizerApi* | [**post_and_optimize**](docs/BPMOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/bpm/v3/optimizations | Create and Run BPM optimization *BPMOptimizerApi* | [**put_and_optimize**](docs/BPMOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/bpm/v3/optimizations/{id} | Create or Update BPM optimization and run it. *BenchmarksApi* | [**get_spar_benchmark_by_id**](docs/BenchmarksApi.md#get_spar_benchmark_by_id) | **GET** /analytics/engines/spar/v3/benchmarks | Get SPAR benchmark details -*ColumnStatisticsApi* | [**get_pa_column_statistics**](docs/ColumnStatisticsApi.md#get_pa_column_statistics) | **GET** /analytics/engines/pa/v3/columnstatistics | Get PA column statistics -*ColumnsApi* | [**get_pa_column_by_id**](docs/ColumnsApi.md#get_pa_column_by_id) | **GET** /analytics/engines/pa/v3/columns/{id} | Get PA column settings -*ColumnsApi* | [**get_pa_columns**](docs/ColumnsApi.md#get_pa_columns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns -*ComponentsApi* | [**get_pa_component_by_id**](docs/ComponentsApi.md#get_pa_component_by_id) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id -*ComponentsApi* | [**get_pa_components**](docs/ComponentsApi.md#get_pa_components) | **GET** /analytics/engines/pa/v3/components | Get PA components *ComponentsApi* | [**get_spar_component_by_id**](docs/ComponentsApi.md#get_spar_component_by_id) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id *ComponentsApi* | [**get_spar_components**](docs/ComponentsApi.md#get_spar_components) | **GET** /analytics/engines/spar/v3/components | Get SPAR components *ComponentsApi* | [**get_vault_component_by_id**](docs/ComponentsApi.md#get_vault_component_by_id) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id @@ -130,10 +125,8 @@ Class | Method | HTTP request | Description *ConfigurationsApi* | [**get_vault_configuration_by_id**](docs/ConfigurationsApi.md#get_vault_configuration_by_id) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id *ConfigurationsApi* | [**get_vault_configurations**](docs/ConfigurationsApi.md#get_vault_configurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations *CurrenciesApi* | [**get_currencies**](docs/CurrenciesApi.md#get_currencies) | **GET** /analytics/lookups/v3/currencies | Get currencies -*DatesApi* | [**convert_pa_dates_to_absolute_format**](docs/DatesApi.md#convert_pa_dates_to_absolute_format) | **GET** /analytics/engines/pa/v3/dates | Convert PA dates to absolute format *DatesApi* | [**convert_vault_dates_to_absolute_format**](docs/DatesApi.md#convert_vault_dates_to_absolute_format) | **GET** /analytics/engines/vault/v3/dates | Convert Vault dates to absolute format *DiscountCurvesApi* | [**get_all_fi_discount_curves**](docs/DiscountCurvesApi.md#get_all_fi_discount_curves) | **GET** /analytics/engines/fi/v3/discount-curves | Get Discount Curves -*DocumentsApi* | [**get_pa3_documents**](docs/DocumentsApi.md#get_pa3_documents) | **GET** /analytics/engines/pa/v3/documents/{path} | Get PA3 documents and sub-directories in a directory *DocumentsApi* | [**get_pub_documents**](docs/DocumentsApi.md#get_pub_documents) | **GET** /analytics/engines/pub/v3/documents/{path} | Gets Publisher documents and sub-directories in a directory *DocumentsApi* | [**get_spar3_documents**](docs/DocumentsApi.md#get_spar3_documents) | **GET** /analytics/engines/spar/v3/documents/{path} | Gets SPAR3 documents and sub-directories in a directory *DocumentsApi* | [**get_vault_documents**](docs/DocumentsApi.md#get_vault_documents) | **GET** /analytics/engines/vault/v3/documents/{path} | Get Vault documents and sub-directories in a directory @@ -146,36 +139,14 @@ Class | Method | HTTP request | Description *FICalculationsApi* | [**get_calculation_status_by_id**](docs/FICalculationsApi.md#get_calculation_status_by_id) | **GET** /analytics/engines/fi/v3/calculations/{id}/status | Get FI calculation status by id *FICalculationsApi* | [**post_and_calculate**](docs/FICalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/fi/v3/calculations | Create and Run FI calculation *FICalculationsApi* | [**put_and_calculate**](docs/FICalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/fi/v3/calculations/{id} | Create or Update FI calculation and run it. -*FPOOptimizerApi* | [**cancel_optimization_by_id**](docs/FPOOptimizerApi.md#cancel_optimization_by_id) | **DELETE** /analytics/engines/fpo/v3/optimizations/{id} | Cancel FPO optimization by id -*FPOOptimizerApi* | [**get_optimization_parameters**](docs/FPOOptimizerApi.md#get_optimization_parameters) | **GET** /analytics/engines/fpo/v3/optimizations/{id} | Get FPO optimization parameters by id -*FPOOptimizerApi* | [**get_optimization_result**](docs/FPOOptimizerApi.md#get_optimization_result) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/result | Get FPO optimization result by id -*FPOOptimizerApi* | [**get_optimization_status_by_id**](docs/FPOOptimizerApi.md#get_optimization_status_by_id) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/status | Get FPO optimization status by id -*FPOOptimizerApi* | [**post_and_optimize**](docs/FPOOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/fpo/v3/optimizations | Create and Run FPO optimization -*FPOOptimizerApi* | [**put_and_optimize**](docs/FPOOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/fpo/v3/optimizations/{id} | Create or Update FPO optimization and run it. -*FrequenciesApi* | [**get_pa_frequencies**](docs/FrequenciesApi.md#get_pa_frequencies) | **GET** /analytics/engines/pa/v3/frequencies | Get PA frequencies *FrequenciesApi* | [**get_spar_frequencies**](docs/FrequenciesApi.md#get_spar_frequencies) | **GET** /analytics/engines/spar/v3/frequencies | Get SPAR frequencies *FrequenciesApi* | [**get_vault_frequencies**](docs/FrequenciesApi.md#get_vault_frequencies) | **GET** /analytics/engines/vault/v3/frequencies | Get Vault frequencies -*GroupsApi* | [**get_pa_grouping_frequencies**](docs/GroupsApi.md#get_pa_grouping_frequencies) | **GET** /analytics/engines/pa/v3/grouping-frequencies | Get PA grouping frequencies -*GroupsApi* | [**get_pa_groups**](docs/GroupsApi.md#get_pa_groups) | **GET** /analytics/engines/pa/v3/groups | Get PA groups -*LinkedPATemplatesApi* | [**create_linked_pa_templates**](docs/LinkedPATemplatesApi.md#create_linked_pa_templates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template -*LinkedPATemplatesApi* | [**delete_linked_pa_templates**](docs/LinkedPATemplatesApi.md#delete_linked_pa_templates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. -*LinkedPATemplatesApi* | [**get_linked_pa_templates**](docs/LinkedPATemplatesApi.md#get_linked_pa_templates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates -*LinkedPATemplatesApi* | [**get_linked_pa_templates_by_id**](docs/LinkedPATemplatesApi.md#get_linked_pa_templates_by_id) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id -*LinkedPATemplatesApi* | [**update_linked_pa_templates**](docs/LinkedPATemplatesApi.md#update_linked_pa_templates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template *NPOOptimizerApi* | [**cancel_optimization_by_id**](docs/NPOOptimizerApi.md#cancel_optimization_by_id) | **DELETE** /analytics/engines/npo/v3/optimizations/{id} | Cancel NPO optimization by id *NPOOptimizerApi* | [**get_optimization_parameters**](docs/NPOOptimizerApi.md#get_optimization_parameters) | **GET** /analytics/engines/npo/v3/optimizations/{id} | Get NPO optimization parameters by id *NPOOptimizerApi* | [**get_optimization_result**](docs/NPOOptimizerApi.md#get_optimization_result) | **GET** /analytics/engines/npo/v3/optimizations/{id}/result | Get NPO optimization result by id *NPOOptimizerApi* | [**get_optimization_status_by_id**](docs/NPOOptimizerApi.md#get_optimization_status_by_id) | **GET** /analytics/engines/npo/v3/optimizations/{id}/status | Get NPO optimization status by id *NPOOptimizerApi* | [**post_and_optimize**](docs/NPOOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/npo/v3/optimizations | Create and Run NPO optimization *NPOOptimizerApi* | [**put_and_optimize**](docs/NPOOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/npo/v3/optimizations/{id} | Create or Update NPO optimization and run it. -*PACalculationsApi* | [**cancel_calculation_by_id**](docs/PACalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id -*PACalculationsApi* | [**get_all_calculations**](docs/PACalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations -*PACalculationsApi* | [**get_calculation_parameters**](docs/PACalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id -*PACalculationsApi* | [**get_calculation_status_by_id**](docs/PACalculationsApi.md#get_calculation_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id -*PACalculationsApi* | [**get_calculation_unit_result_by_id**](docs/PACalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id -*PACalculationsApi* | [**post_and_calculate**](docs/PACalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation -*PACalculationsApi* | [**put_and_calculate**](docs/PACalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. -*PricingSourcesApi* | [**get_pa_pricing_sources**](docs/PricingSourcesApi.md#get_pa_pricing_sources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources *PubCalculationsApi* | [**cancel_calculation_by_id**](docs/PubCalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/pub/v3/calculations/{id} | Cancel Pub calculation by id *PubCalculationsApi* | [**get_all_calculations**](docs/PubCalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/pub/v3/calculations | Get all calculations *PubCalculationsApi* | [**get_calculation_parameters**](docs/PubCalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/pub/v3/calculations/{id} | Get Pub calculation parameters by id @@ -201,20 +172,7 @@ Class | Method | HTTP request | Description *StrategyDocumentsApi* | [**get_axioma_equity_strategy_documents**](docs/StrategyDocumentsApi.md#get_axioma_equity_strategy_documents) | **GET** /analytics/engines/axp/v3/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**get_axioma_fi_strategy_documents**](docs/StrategyDocumentsApi.md#get_axioma_fi_strategy_documents) | **GET** /analytics/engines/afi/v3/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**get_barra_strategy_documents**](docs/StrategyDocumentsApi.md#get_barra_strategy_documents) | **GET** /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory -*StrategyDocumentsApi* | [**get_fpo_strategy_documents**](docs/StrategyDocumentsApi.md#get_fpo_strategy_documents) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**get_northfield_strategy_documents**](docs/StrategyDocumentsApi.md#get_northfield_strategy_documents) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory -*TemplatedPAComponentsApi* | [**create_templated_pa_components**](docs/TemplatedPAComponentsApi.md#create_templated_pa_components) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component -*TemplatedPAComponentsApi* | [**delete_templated_pa_components**](docs/TemplatedPAComponentsApi.md#delete_templated_pa_components) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component -*TemplatedPAComponentsApi* | [**get_templated_pa_component_by_id**](docs/TemplatedPAComponentsApi.md#get_templated_pa_component_by_id) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id -*TemplatedPAComponentsApi* | [**get_templated_pa_components_in_path**](docs/TemplatedPAComponentsApi.md#get_templated_pa_components_in_path) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path -*TemplatedPAComponentsApi* | [**update_templated_pa_components**](docs/TemplatedPAComponentsApi.md#update_templated_pa_components) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component -*UnlinkedPATemplatesApi* | [**create_unlinked_pa_templates**](docs/UnlinkedPATemplatesApi.md#create_unlinked_pa_templates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template -*UnlinkedPATemplatesApi* | [**delete_unlinked_pa_templates**](docs/UnlinkedPATemplatesApi.md#delete_unlinked_pa_templates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template -*UnlinkedPATemplatesApi* | [**get_default_unlinked_pa_template_types**](docs/UnlinkedPATemplatesApi.md#get_default_unlinked_pa_template_types) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. -*UnlinkedPATemplatesApi* | [**get_details_type**](docs/UnlinkedPATemplatesApi.md#get_details_type) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. -*UnlinkedPATemplatesApi* | [**get_unlinked_pa_templates**](docs/UnlinkedPATemplatesApi.md#get_unlinked_pa_templates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates -*UnlinkedPATemplatesApi* | [**get_unlinked_pa_templates_by_id**](docs/UnlinkedPATemplatesApi.md#get_unlinked_pa_templates_by_id) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id -*UnlinkedPATemplatesApi* | [**update_unlinked_pa_templates**](docs/UnlinkedPATemplatesApi.md#update_unlinked_pa_templates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template *VaultCalculationsApi* | [**cancel_calculation_by_id**](docs/VaultCalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/vault/v3/calculations/{id} | Cancel Vault calculation by id *VaultCalculationsApi* | [**get_all_calculations**](docs/VaultCalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/vault/v3/calculations | Get all calculations *VaultCalculationsApi* | [**get_calculation_parameters**](docs/VaultCalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/vault/v3/calculations/{id} | Get Vault calculation parameters by id @@ -222,6 +180,7 @@ Class | Method | HTTP request | Description *VaultCalculationsApi* | [**get_calculation_unit_result_by_id**](docs/VaultCalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result | Get Vault calculation result by id *VaultCalculationsApi* | [**post_and_calculate**](docs/VaultCalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/vault/v3/calculations | Create and Run Vault calculation *VaultCalculationsApi* | [**put_and_calculate**](docs/VaultCalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/vault/v3/calculations/{id} | Create or Update Vault calculation and run it. +*VaultAttributionLoaderApi* | [**vault_attribution_loader**](docs/VaultAttributionLoaderApi.md#vault_attribution_loader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader ## Documentation For Models @@ -253,12 +212,6 @@ Class | Method | HTTP request | Description - [CalculationsSummary](docs/CalculationsSummary.md) - [CalculationsSummaryRoot](docs/CalculationsSummaryRoot.md) - [ClientErrorResponse](docs/ClientErrorResponse.md) - - [Column](docs/Column.md) - - [ColumnRoot](docs/ColumnRoot.md) - - [ColumnStatistic](docs/ColumnStatistic.md) - - [ColumnStatisticRoot](docs/ColumnStatisticRoot.md) - - [ColumnSummary](docs/ColumnSummary.md) - - [ColumnSummaryRoot](docs/ColumnSummaryRoot.md) - [ComponentSummary](docs/ComponentSummary.md) - [ComponentSummaryRoot](docs/ComponentSummaryRoot.md) - [ConfigurationAccount](docs/ConfigurationAccount.md) @@ -284,6 +237,7 @@ Class | Method | HTTP request | Description - [FICalculationParameters](docs/FICalculationParameters.md) - [FICalculationParametersRoot](docs/FICalculationParametersRoot.md) - [FICashflows](docs/FICashflows.md) + - [FIConvertibleSettings](docs/FIConvertibleSettings.md) - [FIDiscountCurveInfo](docs/FIDiscountCurveInfo.md) - [FIDiscountCurveInfoRoot](docs/FIDiscountCurveInfoRoot.md) - [FIJobSettings](docs/FIJobSettings.md) @@ -300,26 +254,8 @@ Class | Method | HTTP request | Description - [FIServicerAdvancesForSecurities](docs/FIServicerAdvancesForSecurities.md) - [FIStructuredProductsForJobSettings](docs/FIStructuredProductsForJobSettings.md) - [FIStructuredProductsForSecurities](docs/FIStructuredProductsForSecurities.md) - - [FPOAccount](docs/FPOAccount.md) - - [FPOObjective](docs/FPOObjective.md) - - [FPOOptimizationParameters](docs/FPOOptimizationParameters.md) - - [FPOOptimizationParametersRoot](docs/FPOOptimizationParametersRoot.md) - - [FPOOptimizerStrategy](docs/FPOOptimizerStrategy.md) - - [FPOOptimizerStrategyOverrides](docs/FPOOptimizerStrategyOverrides.md) - [Frequency](docs/Frequency.md) - [FrequencyRoot](docs/FrequencyRoot.md) - - [Group](docs/Group.md) - - [GroupRoot](docs/GroupRoot.md) - - [LinkedPATemplate](docs/LinkedPATemplate.md) - - [LinkedPATemplateParameters](docs/LinkedPATemplateParameters.md) - - [LinkedPATemplateParametersRoot](docs/LinkedPATemplateParametersRoot.md) - - [LinkedPATemplatePostSummary](docs/LinkedPATemplatePostSummary.md) - - [LinkedPATemplatePostSummaryRoot](docs/LinkedPATemplatePostSummaryRoot.md) - - [LinkedPATemplateRoot](docs/LinkedPATemplateRoot.md) - - [LinkedPATemplateSummary](docs/LinkedPATemplateSummary.md) - - [LinkedPATemplateSummaryRoot](docs/LinkedPATemplateSummaryRoot.md) - - [LinkedPATemplateUpdateParameters](docs/LinkedPATemplateUpdateParameters.md) - - [LinkedPATemplateUpdateParametersRoot](docs/LinkedPATemplateUpdateParametersRoot.md) - [NPOOptimizationParameters](docs/NPOOptimizationParameters.md) - [NPOOptimizationParametersRoot](docs/NPOOptimizationParametersRoot.md) - [NPOOptimizerStrategy](docs/NPOOptimizerStrategy.md) @@ -332,20 +268,6 @@ Class | Method | HTTP request | Description - [OptimizerOptimalHoldings](docs/OptimizerOptimalHoldings.md) - [OptimizerOutputTypes](docs/OptimizerOutputTypes.md) - [OptimizerTradesList](docs/OptimizerTradesList.md) - - [PACalculationColumn](docs/PACalculationColumn.md) - - [PACalculationDataSources](docs/PACalculationDataSources.md) - - [PACalculationGroup](docs/PACalculationGroup.md) - - [PACalculationParameters](docs/PACalculationParameters.md) - - [PACalculationParametersRoot](docs/PACalculationParametersRoot.md) - - [PACalculationPricingSource](docs/PACalculationPricingSource.md) - - [PAComponent](docs/PAComponent.md) - - [PAComponentData](docs/PAComponentData.md) - - [PAComponentRoot](docs/PAComponentRoot.md) - - [PADateParameters](docs/PADateParameters.md) - - [PAIdentifier](docs/PAIdentifier.md) - - [PAPricingSource](docs/PAPricingSource.md) - - [PAPricingSourceRoot](docs/PAPricingSourceRoot.md) - - [PaDoc](docs/PaDoc.md) - [PaginationInfo](docs/PaginationInfo.md) - [PaginationMeta](docs/PaginationMeta.md) - [PubCalculationParameters](docs/PubCalculationParameters.md) @@ -358,22 +280,14 @@ Class | Method | HTTP request | Description - [QuantCalculationParametersRoot](docs/QuantCalculationParametersRoot.md) - [QuantDate](docs/QuantDate.md) - [QuantDateList](docs/QuantDateList.md) - - [QuantDateListObsolete](docs/QuantDateListObsolete.md) - [QuantFdsDate](docs/QuantFdsDate.md) - - [QuantFdsDateObsolete](docs/QuantFdsDateObsolete.md) - [QuantFormula](docs/QuantFormula.md) - [QuantFqlExpression](docs/QuantFqlExpression.md) - - [QuantFqlExpressionObsolete](docs/QuantFqlExpressionObsolete.md) - [QuantIdentifierUniverse](docs/QuantIdentifierUniverse.md) - - [QuantIdentifierUniverseObsolete](docs/QuantIdentifierUniverseObsolete.md) - [QuantScreeningExpression](docs/QuantScreeningExpression.md) - - [QuantScreeningExpressionObsolete](docs/QuantScreeningExpressionObsolete.md) - [QuantScreeningExpressionUniverse](docs/QuantScreeningExpressionUniverse.md) - - [QuantScreeningExpressionUniverseObsolete](docs/QuantScreeningExpressionUniverseObsolete.md) - [QuantUniversalScreenParameter](docs/QuantUniversalScreenParameter.md) - - [QuantUniversalScreenParameterObsolete](docs/QuantUniversalScreenParameterObsolete.md) - [QuantUniversalScreenUniverse](docs/QuantUniversalScreenUniverse.md) - - [QuantUniversalScreenUniverseObsolete](docs/QuantUniversalScreenUniverseObsolete.md) - [QuantUniverse](docs/QuantUniverse.md) - [ReturnType](docs/ReturnType.md) - [SPARAccounts](docs/SPARAccounts.md) @@ -386,33 +300,8 @@ Class | Method | HTTP request | Description - [SPARComponentRoot](docs/SPARComponentRoot.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) - - [TemplateContentTypes](docs/TemplateContentTypes.md) - - [TemplatedPAComponent](docs/TemplatedPAComponent.md) - - [TemplatedPAComponentParameters](docs/TemplatedPAComponentParameters.md) - - [TemplatedPAComponentParametersRoot](docs/TemplatedPAComponentParametersRoot.md) - - [TemplatedPAComponentPostSummary](docs/TemplatedPAComponentPostSummary.md) - - [TemplatedPAComponentPostSummaryRoot](docs/TemplatedPAComponentPostSummaryRoot.md) - - [TemplatedPAComponentRoot](docs/TemplatedPAComponentRoot.md) - - [TemplatedPAComponentSummary](docs/TemplatedPAComponentSummary.md) - - [TemplatedPAComponentSummaryRoot](docs/TemplatedPAComponentSummaryRoot.md) - - [TemplatedPAComponentUpdateParameters](docs/TemplatedPAComponentUpdateParameters.md) - - [TemplatedPAComponentUpdateParametersRoot](docs/TemplatedPAComponentUpdateParametersRoot.md) - - [UnlinkedPATemplate](docs/UnlinkedPATemplate.md) - - [UnlinkedPATemplateCategoryAndType](docs/UnlinkedPATemplateCategoryAndType.md) - - [UnlinkedPATemplateCategoryAndTypeDetails](docs/UnlinkedPATemplateCategoryAndTypeDetails.md) - - [UnlinkedPATemplateCategoryAndTypeDetailsRoot](docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md) - - [UnlinkedPATemplateCategoryAndTypeRoot](docs/UnlinkedPATemplateCategoryAndTypeRoot.md) - - [UnlinkedPATemplateColumnDetails](docs/UnlinkedPATemplateColumnDetails.md) - - [UnlinkedPATemplateGroupDetails](docs/UnlinkedPATemplateGroupDetails.md) - - [UnlinkedPATemplateParameters](docs/UnlinkedPATemplateParameters.md) - - [UnlinkedPATemplateParametersRoot](docs/UnlinkedPATemplateParametersRoot.md) - - [UnlinkedPATemplatePostSummary](docs/UnlinkedPATemplatePostSummary.md) - - [UnlinkedPATemplatePostSummaryRoot](docs/UnlinkedPATemplatePostSummaryRoot.md) - - [UnlinkedPATemplateRoot](docs/UnlinkedPATemplateRoot.md) - - [UnlinkedPATemplateSummary](docs/UnlinkedPATemplateSummary.md) - - [UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md) - - [UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md) - - [UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md) + - [VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md) + - [VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md) - [VaultCalculationParameters](docs/VaultCalculationParameters.md) - [VaultCalculationParametersRoot](docs/VaultCalculationParametersRoot.md) - [VaultComponent](docs/VaultComponent.md) diff --git a/auto-generated-sdk/docs/AccountDirectories.md b/auto-generated-sdk/docs/AccountDirectories.md index d05408be..48b6a59f 100644 --- a/auto-generated-sdk/docs/AccountDirectories.md +++ b/auto-generated-sdk/docs/AccountDirectories.md @@ -1,5 +1,6 @@ # AccountDirectories +List of the accounts and directories. ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/CalculationStatus.md b/auto-generated-sdk/docs/CalculationStatus.md index 6dba1313..5b242ac3 100644 --- a/auto-generated-sdk/docs/CalculationStatus.md +++ b/auto-generated-sdk/docs/CalculationStatus.md @@ -1,5 +1,6 @@ # CalculationStatus +Details of the calculation. ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/CalculationStatusMeta.md b/auto-generated-sdk/docs/CalculationStatusMeta.md index 0bf11b2d..513749fd 100644 --- a/auto-generated-sdk/docs/CalculationStatusMeta.md +++ b/auto-generated-sdk/docs/CalculationStatusMeta.md @@ -1,10 +1,11 @@ # CalculationStatusMeta +Meta of calculation units in batch. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**units** | [**{str: (CalculationUnitStatusMeta,)}**](CalculationUnitStatusMeta.md) | Meta of calculation units in batch. | [optional] +**units** | [**{str: (CalculationUnitStatusMeta,)}**](CalculationUnitStatusMeta.md) | List of calculation units in batch. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md index f0968651..c9891da8 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatus.md +++ b/auto-generated-sdk/docs/CalculationUnitStatus.md @@ -1,5 +1,6 @@ # CalculationUnitStatus +The status of the calculation as per FactSets API standards ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/CalculationUnitStatusMeta.md b/auto-generated-sdk/docs/CalculationUnitStatusMeta.md index 7700622c..2aff1bf1 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatusMeta.md +++ b/auto-generated-sdk/docs/CalculationUnitStatusMeta.md @@ -1,5 +1,6 @@ # CalculationUnitStatusMeta +Meta of the calculation unit. ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/Column.md b/auto-generated-sdk/docs/Column.md deleted file mode 100644 index 9f70e302..00000000 --- a/auto-generated-sdk/docs/Column.md +++ /dev/null @@ -1,14 +0,0 @@ -# Column - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**defaultstatisticsids** | **[str]** | Column statistic Id | [optional] -**name** | **str** | Column Name | [optional] -**directory** | **str** | Column Directory | [optional] -**category** | **str** | Column Category | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/ColumnStatistic.md b/auto-generated-sdk/docs/ColumnStatistic.md deleted file mode 100644 index 64af5560..00000000 --- a/auto-generated-sdk/docs/ColumnStatistic.md +++ /dev/null @@ -1,11 +0,0 @@ -# ColumnStatistic - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Column Statistic Name | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/ColumnStatisticRoot.md b/auto-generated-sdk/docs/ColumnStatisticRoot.md deleted file mode 100644 index 9b56aab0..00000000 --- a/auto-generated-sdk/docs/ColumnStatisticRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# ColumnStatisticRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (ColumnStatistic,)}**](ColumnStatistic.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/ColumnStatisticsApi.md b/auto-generated-sdk/docs/ColumnStatisticsApi.md deleted file mode 100644 index fde2a8d5..00000000 --- a/auto-generated-sdk/docs/ColumnStatisticsApi.md +++ /dev/null @@ -1,95 +0,0 @@ - -# fds.analyticsapi.engines.ColumnStatisticsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_pa_column_statistics**](ColumnStatisticsApi.md#get_pa_column_statistics) | **GET** /analytics/engines/pa/v3/columnstatistics | Get PA column statistics - - -# **get_pa_column_statistics** -> ColumnStatisticRoot get_pa_column_statistics() - -Get PA column statistics - -This endpoint lists all the column statistics that can be applied to a PA column. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import column_statistics_api -from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = column_statistics_api.ColumnStatisticsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # Get PA column statistics - api_response = api_instance.get_pa_column_statistics() - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling ColumnStatisticsApi->get_pa_column_statistics: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**ColumnStatisticRoot**](ColumnStatisticRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/ColumnSummary.md b/auto-generated-sdk/docs/ColumnSummary.md deleted file mode 100644 index 46bc660f..00000000 --- a/auto-generated-sdk/docs/ColumnSummary.md +++ /dev/null @@ -1,14 +0,0 @@ -# ColumnSummary - -Column settings (name, directory, category) - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Column Name | [optional] -**directory** | **str** | Column Directory | [optional] -**category** | **str** | Column Category | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/ColumnsApi.md b/auto-generated-sdk/docs/ColumnsApi.md deleted file mode 100644 index 5a64878c..00000000 --- a/auto-generated-sdk/docs/ColumnsApi.md +++ /dev/null @@ -1,197 +0,0 @@ - -# fds.analyticsapi.engines.ColumnsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_pa_column_by_id**](ColumnsApi.md#get_pa_column_by_id) | **GET** /analytics/engines/pa/v3/columns/{id} | Get PA column settings -[**get_pa_columns**](ColumnsApi.md#get_pa_columns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns - - -# **get_pa_column_by_id** -> ColumnRoot get_pa_column_by_id(id) - -Get PA column settings - -This endpoint returns the default settings of a PA column. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import columns_api -from fds.analyticsapi.engines.model.column_root import ColumnRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = columns_api.ColumnsApi(api_client) - id = "2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7" # str | Unique identifier for a column - - # example passing only required values which don't have defaults set - try: - # Get PA column settings - api_response = api_instance.get_pa_column_by_id(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling ColumnsApi->get_pa_column_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for a column | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**ColumnRoot**](ColumnRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pa_columns** -> ColumnSummaryRoot get_pa_columns() - -Get PA columns - -This endpoint lists all the PA columns that can be applied to a calculation. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import columns_api -from fds.analyticsapi.engines.model.column_summary_root import ColumnSummaryRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = columns_api.ColumnsApi(api_client) - name = "Security Name" # str | Column name (optional) if omitted the server will use the default value of "" - category = "" # str | Column category (optional) if omitted the server will use the default value of "" - directory = "Client" # str | The directory to get the columns in (optional) if omitted the server will use the default value of "" - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get PA columns - api_response = api_instance.get_pa_columns(name=name, category=category, directory=directory) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling ColumnsApi->get_pa_columns: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Column name | [optional] if omitted the server will use the default value of "" - **category** | **str**| Column category | [optional] if omitted the server will use the default value of "" - **directory** | **str**| The directory to get the columns in | [optional] if omitted the server will use the default value of "" - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**ColumnSummaryRoot**](ColumnSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index 26a2b66c..e6d82125 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -5,198 +5,12 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_pa_component_by_id**](ComponentsApi.md#get_pa_component_by_id) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id -[**get_pa_components**](ComponentsApi.md#get_pa_components) | **GET** /analytics/engines/pa/v3/components | Get PA components [**get_spar_component_by_id**](ComponentsApi.md#get_spar_component_by_id) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id [**get_spar_components**](ComponentsApi.md#get_spar_components) | **GET** /analytics/engines/spar/v3/components | Get SPAR components [**get_vault_component_by_id**](ComponentsApi.md#get_vault_component_by_id) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id [**get_vault_components**](ComponentsApi.md#get_vault_components) | **GET** /analytics/engines/vault/v3/components | Get Vault components -# **get_pa_component_by_id** -> PAComponentRoot get_pa_component_by_id(id) - -Get PA component by id - -This endpoint returns the default settings of a PA component. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import components_api -from fds.analyticsapi.engines.model.pa_component_root import PAComponentRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = components_api.ComponentsApi(api_client) - id = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" # str | Unique identifier for a PA component - - # example passing only required values which don't have defaults set - try: - # Get PA component by id - api_response = api_instance.get_pa_component_by_id(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling ComponentsApi->get_pa_component_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for a PA component | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**PAComponentRoot**](PAComponentRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns the default settings of a 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pa_components** -> ComponentSummaryRoot get_pa_components(document) - -Get PA components - -This endpoint returns the list of PA components in a given PA document. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import components_api -from fds.analyticsapi.engines.model.component_summary_root import ComponentSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = components_api.ComponentsApi(api_client) - document = "PA3_DOCUMENTS:DEFAULT" # str | Document Name - - # example passing only required values which don't have defaults set - try: - # Get PA components - api_response = api_instance.get_pa_components(document) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling ComponentsApi->get_pa_components: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **document** | **str**| Document Name | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**ComponentSummaryRoot**](ComponentSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of PA components. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Document not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_spar_component_by_id** > SPARComponentRoot get_spar_component_by_id(id) @@ -425,7 +239,7 @@ configuration = fds.analyticsapi.engines.Configuration( with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = components_api.ComponentsApi(api_client) - id = "id_example" # str | Unique identifier for a vault component + id = "AFB43C61A6651B87988FEA62ED333638595AE7D8D7345A33AB9994CF23AFCC5D" # str | Unique identifier for a vault component # example passing only required values which don't have defaults set try: @@ -517,7 +331,7 @@ configuration = fds.analyticsapi.engines.Configuration( with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = components_api.ComponentsApi(api_client) - document = "document_example" # str | Document Name + document = "CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT" # str | Document Name # example passing only required values which don't have defaults set try: diff --git a/auto-generated-sdk/docs/ConfigurationsApi.md b/auto-generated-sdk/docs/ConfigurationsApi.md index e69e4abe..f9dc5c7e 100644 --- a/auto-generated-sdk/docs/ConfigurationsApi.md +++ b/auto-generated-sdk/docs/ConfigurationsApi.md @@ -53,7 +53,7 @@ configuration = fds.analyticsapi.engines.Configuration( with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = configurations_api.ConfigurationsApi(api_client) - id = "id_example" # str | Vault configuration id to get the details of + id = "e95ef921-b4d4-4bb7-93ba-60eca8e3247a" # str | Vault configuration id to get the details of # example passing only required values which don't have defaults set try: @@ -145,7 +145,7 @@ configuration = fds.analyticsapi.engines.Configuration( with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = configurations_api.ConfigurationsApi(api_client) - account = "account_example" # str | Required account query parameter to filter configurations for a specific account + account = "CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT" # str | Required account query parameter to filter configurations for a specific account # example passing only required values which don't have defaults set try: diff --git a/auto-generated-sdk/docs/Currency.md b/auto-generated-sdk/docs/Currency.md index ed1ec221..88408ae9 100644 --- a/auto-generated-sdk/docs/Currency.md +++ b/auto-generated-sdk/docs/Currency.md @@ -1,5 +1,6 @@ # Currency +Details of the currency. ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/DatesApi.md b/auto-generated-sdk/docs/DatesApi.md index f238c057..3f378315 100644 --- a/auto-generated-sdk/docs/DatesApi.md +++ b/auto-generated-sdk/docs/DatesApi.md @@ -5,117 +5,9 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**convert_pa_dates_to_absolute_format**](DatesApi.md#convert_pa_dates_to_absolute_format) | **GET** /analytics/engines/pa/v3/dates | Convert PA dates to absolute format [**convert_vault_dates_to_absolute_format**](DatesApi.md#convert_vault_dates_to_absolute_format) | **GET** /analytics/engines/vault/v3/dates | Convert Vault dates to absolute format -# **convert_pa_dates_to_absolute_format** -> DateParametersSummaryRoot convert_pa_dates_to_absolute_format(enddate, componentid, account) - -Convert PA dates to absolute format - -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 - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import dates_api -from fds.analyticsapi.engines.model.date_parameters_summary_root import DateParametersSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = dates_api.DatesApi(api_client) - enddate = "-1AY" # str | End Date - componentid = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" # str | Component Id - account = "Client:/Folder1/Folder2/AccountName.ACCT" # str | Account ( Account Name ending with .ACCT or .ACTM ) - startdate = "-3AY" # str | Start Date (optional) - - # example passing only required values which don't have defaults set - try: - # Convert PA dates to absolute format - api_response = api_instance.convert_pa_dates_to_absolute_format(enddate, componentid, account) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling DatesApi->convert_pa_dates_to_absolute_format: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Convert PA dates to absolute format - api_response = api_instance.convert_pa_dates_to_absolute_format(enddate, componentid, account, startdate=startdate) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling DatesApi->convert_pa_dates_to_absolute_format: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **enddate** | **str**| End Date | - **componentid** | **str**| Component Id | - **account** | **str**| Account ( Account Name ending with .ACCT or .ACTM ) | - **startdate** | **str**| Start Date | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**DateParametersSummaryRoot**](DateParametersSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns the 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Document 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **convert_vault_dates_to_absolute_format** > DateParametersSummaryRoot convert_vault_dates_to_absolute_format(enddate, componentid, account) diff --git a/auto-generated-sdk/docs/DocumentsApi.md b/auto-generated-sdk/docs/DocumentsApi.md index 787fdec2..e11e39de 100644 --- a/auto-generated-sdk/docs/DocumentsApi.md +++ b/auto-generated-sdk/docs/DocumentsApi.md @@ -5,104 +5,11 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_pa3_documents**](DocumentsApi.md#get_pa3_documents) | **GET** /analytics/engines/pa/v3/documents/{path} | Get PA3 documents and sub-directories in a directory [**get_pub_documents**](DocumentsApi.md#get_pub_documents) | **GET** /analytics/engines/pub/v3/documents/{path} | Gets Publisher documents and sub-directories in a directory [**get_spar3_documents**](DocumentsApi.md#get_spar3_documents) | **GET** /analytics/engines/spar/v3/documents/{path} | Gets SPAR3 documents and sub-directories in a directory [**get_vault_documents**](DocumentsApi.md#get_vault_documents) | **GET** /analytics/engines/vault/v3/documents/{path} | Get Vault documents and sub-directories in a directory -# **get_pa3_documents** -> DocumentDirectoriesRoot get_pa3_documents(path) - -Get PA3 documents and sub-directories in a directory - -This endpoint looks up all PA3 documents and sub-directories in a given directory. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import documents_api -from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = documents_api.DocumentsApi(api_client) - path = "Client:" # str | The directory to get the documents and sub-directories in - - # example passing only required values which don't have defaults set - try: - # Get PA3 documents and sub-directories in a directory - api_response = api_instance.get_pa3_documents(path) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling DocumentsApi->get_pa3_documents: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str**| The directory to get the documents and sub-directories in | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**DocumentDirectoriesRoot**](DocumentDirectoriesRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in 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.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_pub_documents** > DocumentDirectoriesRoot get_pub_documents(path) diff --git a/auto-generated-sdk/docs/FICalculationsApi.md b/auto-generated-sdk/docs/FICalculationsApi.md index 065f14e6..1328c54c 100644 --- a/auto-generated-sdk/docs/FICalculationsApi.md +++ b/auto-generated-sdk/docs/FICalculationsApi.md @@ -85,7 +85,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -484,6 +484,14 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: end_spread=3.14, pricing_method="Inputted Price", ), + convertible=FIConvertibleSettings( + equity_price=3.14, + equity_index_volatility=3.14, + equity_dividend_yield=3.14, + volatility_cap_method="noCap", + volatility_cap_method_value=3.14, + equity_exchange_rate=3.14, + ), calc_from_method="calc_from_method_example", calc_from_value=3.14, face=1, @@ -715,6 +723,14 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: end_spread=3.14, pricing_method="Inputted Price", ), + convertible=FIConvertibleSettings( + equity_price=3.14, + equity_index_volatility=3.14, + equity_dividend_yield=3.14, + volatility_cap_method="noCap", + volatility_cap_method_value=3.14, + equity_exchange_rate=3.14, + ), calc_from_method="calc_from_method_example", calc_from_value=3.14, face=1, diff --git a/auto-generated-sdk/docs/FIConvertibleSettings.md b/auto-generated-sdk/docs/FIConvertibleSettings.md new file mode 100644 index 00000000..25d3f2d7 --- /dev/null +++ b/auto-generated-sdk/docs/FIConvertibleSettings.md @@ -0,0 +1,16 @@ +# FIConvertibleSettings + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**equity_price** | **float** | Equity Price | [optional] +**equity_index_volatility** | **float** | Equity Index Volatility | [optional] +**equity_dividend_yield** | **float** | Equity Dividend Yield | [optional] +**volatility_cap_method** | **str** | Volatility CapMethod | [optional] +**volatility_cap_method_value** | **float** | Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier) | [optional] +**equity_exchange_rate** | **float** | Equity Exchange Rate | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/FISecurity.md b/auto-generated-sdk/docs/FISecurity.md index dc760568..efa31ab6 100644 --- a/auto-generated-sdk/docs/FISecurity.md +++ b/auto-generated-sdk/docs/FISecurity.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **matrix_multiplier** | **float** | Matrix Multiplier | [optional] **structured_products** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) | | [optional] **attribution** | [**FIAttributionForSecurities**](FIAttributionForSecurities.md) | | [optional] +**convertible** | [**FIConvertibleSettings**](FIConvertibleSettings.md) | | [optional] **calc_from_method** | **str** | Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix | [optional] **face** | **float** | Face | [optional] if omitted the server will use the default value of 1 **face_type** | **str** | Face type | [optional] if omitted the server will use the default value of "Current" diff --git a/auto-generated-sdk/docs/FPOAccount.md b/auto-generated-sdk/docs/FPOAccount.md deleted file mode 100644 index d9f394ac..00000000 --- a/auto-generated-sdk/docs/FPOAccount.md +++ /dev/null @@ -1,13 +0,0 @@ -# FPOAccount - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pa_document** | [**PaDoc**](PaDoc.md) | | -**id** | **str** | Account path | [optional] -**overrides** | [**OptimizerAccountOverrides**](OptimizerAccountOverrides.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/FPOObjective.md b/auto-generated-sdk/docs/FPOObjective.md deleted file mode 100644 index ec3a4948..00000000 --- a/auto-generated-sdk/docs/FPOObjective.md +++ /dev/null @@ -1,12 +0,0 @@ -# FPOObjective - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**active** | **str** | | [optional] -**terms** | **{str: (str,)}** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/FPOOptimizationParameters.md b/auto-generated-sdk/docs/FPOOptimizationParameters.md deleted file mode 100644 index c2d5c271..00000000 --- a/auto-generated-sdk/docs/FPOOptimizationParameters.md +++ /dev/null @@ -1,14 +0,0 @@ -# FPOOptimizationParameters - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**strategy** | [**FPOOptimizerStrategy**](FPOOptimizerStrategy.md) | | -**output_types** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | -**account** | [**FPOAccount**](FPOAccount.md) | | [optional] -**optimization** | [**Optimization**](Optimization.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md b/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md deleted file mode 100644 index d5e65cc5..00000000 --- a/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# FPOOptimizationParametersRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**FPOOptimizationParameters**](FPOOptimizationParameters.md) | | [optional] -**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/FPOOptimizerApi.md b/auto-generated-sdk/docs/FPOOptimizerApi.md deleted file mode 100644 index f2f1f745..00000000 --- a/auto-generated-sdk/docs/FPOOptimizerApi.md +++ /dev/null @@ -1,708 +0,0 @@ - -# fds.analyticsapi.engines.FPOOptimizerApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancel_optimization_by_id**](FPOOptimizerApi.md#cancel_optimization_by_id) | **DELETE** /analytics/engines/fpo/v3/optimizations/{id} | Cancel FPO optimization by id -[**get_optimization_parameters**](FPOOptimizerApi.md#get_optimization_parameters) | **GET** /analytics/engines/fpo/v3/optimizations/{id} | Get FPO optimization parameters by id -[**get_optimization_result**](FPOOptimizerApi.md#get_optimization_result) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/result | Get FPO optimization result by id -[**get_optimization_status_by_id**](FPOOptimizerApi.md#get_optimization_status_by_id) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/status | Get FPO optimization status by id -[**post_and_optimize**](FPOOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/fpo/v3/optimizations | Create and Run FPO optimization -[**put_and_optimize**](FPOOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/fpo/v3/optimizations/{id} | Create or Update FPO optimization and run it. - - -# **cancel_optimization_by_id** -> cancel_optimization_by_id(id) - -Cancel FPO optimization by id - -This is the endpoint to cancel a previously submitted optimization. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import fpo_optimizer_api -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Create and Run FPO optimization endpoint - - # example passing only required values which don't have defaults set - try: - # Cancel FPO optimization by id - api_instance.cancel_optimization_by_id(id) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FPOOptimizerApi->cancel_optimization_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Create and Run FPO optimization endpoint | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: None (empty response body) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Expected response, 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_optimization_parameters** -> FPOOptimizationParametersRoot get_optimization_parameters(id) - -Get FPO optimization parameters by id - -This is the endpoint that returns the optimization parameters passed for an optimization. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import fpo_optimizer_api -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Create and Run FPO optimization endpoint - - # example passing only required values which don't have defaults set - try: - # Get FPO optimization parameters by id - api_response = api_instance.get_optimization_parameters(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FPOOptimizerApi->get_optimization_parameters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Create and Run FPO optimization endpoint | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns the FPO optimization parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Optimization 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_optimization_result** -> ObjectRoot get_optimization_result(id) - -Get FPO optimization result by id - -This is the endpoint to get the result of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import fpo_optimizer_api -from fds.analyticsapi.engines.model.object_root import ObjectRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Get FPO optimization status by id endpoint - accept = "Accept_example" # str | Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * (optional) - - # example passing only required values which don't have defaults set - try: - # Get FPO optimization result by id - api_response = api_instance.get_optimization_result(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FPOOptimizerApi->get_optimization_result: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get FPO optimization result by id - api_response = api_instance.get_optimization_result(id, accept=accept) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FPOOptimizerApi->get_optimization_result: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Get FPO optimization status by id endpoint | - **accept** | **str**| Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**ObjectRoot**](ObjectRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response once optimization is completed, returns JSON. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_optimization_status_by_id** -> ObjectRoot get_optimization_status_by_id(id) - -Get FPO optimization status 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 - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import fpo_optimizer_api -from fds.analyticsapi.engines.model.object_root import ObjectRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Create and Run FPO optimization endpoint - - # example passing only required values which don't have defaults set - try: - # Get FPO optimization status by id - api_response = api_instance.get_optimization_status_by_id(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FPOOptimizerApi->get_optimization_status_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Create and Run FPO optimization endpoint | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 202 status - None (empty response body) ) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Expected response once optimization is completed, returns JSON. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **post_and_optimize** -> ObjectRoot post_and_optimize() - -Create and Run FPO optimization - -This endpoint runs FPO optimization specified in the POST body parameters. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import fpo_optimizer_api -from fds.analyticsapi.engines.model.object_root import ObjectRoot -from fds.analyticsapi.engines.model.calculation_info_root import CalculationInfoRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) - x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional) - fpo_optimization_parameters_root = FPOOptimizationParametersRoot( - data=FPOOptimizationParameters( - account=FPOAccount( - pa_document=PaDoc( - id="id_example", - ), - id="id_example", - overrides=OptimizerAccountOverrides( - portfolio="portfolio_example", - benchmark="benchmark_example", - risk_model_id="risk_model_id_example", - currency="currency_example", - ), - ), - strategy=FPOOptimizerStrategy( - overrides=FPOOptimizerStrategyOverrides( - objective=FPOObjective( - active="active_example", - terms={ - "Disable": "Disable", - }, - ), - constraints={ - "Disable": "Disable", - }, - alpha="alpha_example", - transaction_cost="transaction_cost_example", - ), - id="id_example", - ), - optimization=Optimization( - risk_model_date="risk_model_date_example", - backtest_date="backtest_date_example", - cashflow="cashflow_example", - ), - output_types=OptimizerOutputTypes( - trades=OptimizerTradesList( - identifier_type="Asset", - include_cash=True, - ), - optimal=OptimizerOptimalHoldings( - identifier_type="Asset", - include_cash=True, - exclude_zero=True, - ), - account=OptimalPortfolio( - acct_name="acct_name_example", - exclude_zero=True, - archive_date="archive_date_example", - if_acct_exists="abort", - if_ofdb_date_exists="abort", - ), - stats={}, - ), - ), - meta={}, - ) # FPOOptimizationParametersRoot | Optimization Parameters (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Create and Run FPO optimization - api_response = api_instance.post_and_optimize(x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, fpo_optimization_parameters_root=fpo_optimization_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FPOOptimizerApi->post_and_optimize: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] - **cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional] - **fpo_optimization_parameters_root** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md)) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Expected response, contains the poll URL in the Location header. | * 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**201** | Expected response, returns json if optimization is completed in a short span. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid optimization parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | One or more 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Cancel older requests using Cancel 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **put_and_optimize** -> ObjectRoot put_and_optimize(id) - -Create or Update FPO optimization and run it. - -This endpoint updates and run the FPO optimization specified in the PUT body parameters. It also allows the creation of new FPO optimization with custom id. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import fpo_optimizer_api -from fds.analyticsapi.engines.model.object_root import ObjectRoot -from fds.analyticsapi.engines.model.calculation_info_root import CalculationInfoRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Create and Run FPO optimization endpoint - x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional) - fpo_optimization_parameters_root = FPOOptimizationParametersRoot( - data=FPOOptimizationParameters( - account=FPOAccount( - pa_document=PaDoc( - id="id_example", - ), - id="id_example", - overrides=OptimizerAccountOverrides( - portfolio="portfolio_example", - benchmark="benchmark_example", - risk_model_id="risk_model_id_example", - currency="currency_example", - ), - ), - strategy=FPOOptimizerStrategy( - overrides=FPOOptimizerStrategyOverrides( - objective=FPOObjective( - active="active_example", - terms={ - "Disable": "Disable", - }, - ), - constraints={ - "Disable": "Disable", - }, - alpha="alpha_example", - transaction_cost="transaction_cost_example", - ), - id="id_example", - ), - optimization=Optimization( - risk_model_date="risk_model_date_example", - backtest_date="backtest_date_example", - cashflow="cashflow_example", - ), - output_types=OptimizerOutputTypes( - trades=OptimizerTradesList( - identifier_type="Asset", - include_cash=True, - ), - optimal=OptimizerOptimalHoldings( - identifier_type="Asset", - include_cash=True, - exclude_zero=True, - ), - account=OptimalPortfolio( - acct_name="acct_name_example", - exclude_zero=True, - archive_date="archive_date_example", - if_acct_exists="abort", - if_ofdb_date_exists="abort", - ), - stats={}, - ), - ), - meta={}, - ) # FPOOptimizationParametersRoot | Optimization Parameters (optional) - - # example passing only required values which don't have defaults set - try: - # Create or Update FPO optimization and run it. - api_response = api_instance.put_and_optimize(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FPOOptimizerApi->put_and_optimize: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Create or Update FPO optimization and run it. - api_response = api_instance.put_and_optimize(id, x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, fpo_optimization_parameters_root=fpo_optimization_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FPOOptimizerApi->put_and_optimize: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Create and Run FPO optimization endpoint | - **x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] - **cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional] - **fpo_optimization_parameters_root** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md)) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Expected response, contains the poll URL in the Location header. | * 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**201** | Expected response, returns json if optimization is completed in a short span. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid Optimization Parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | One or more 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**409** | Duplicate optimization exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Cancel older requests using Cancel 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/FPOOptimizerStrategy.md b/auto-generated-sdk/docs/FPOOptimizerStrategy.md deleted file mode 100644 index fed697c5..00000000 --- a/auto-generated-sdk/docs/FPOOptimizerStrategy.md +++ /dev/null @@ -1,12 +0,0 @@ -# FPOOptimizerStrategy - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | OptimizerStrategy document path | -**overrides** | [**FPOOptimizerStrategyOverrides**](FPOOptimizerStrategyOverrides.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md b/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md deleted file mode 100644 index 9c8724a0..00000000 --- a/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md +++ /dev/null @@ -1,14 +0,0 @@ -# FPOOptimizerStrategyOverrides - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**objective** | [**FPOObjective**](FPOObjective.md) | | [optional] -**constraints** | **{str: (str,)}** | List of constraints | [optional] -**alpha** | **str** | Alpha | [optional] -**transaction_cost** | **str** | Transaction cost | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/FrequenciesApi.md b/auto-generated-sdk/docs/FrequenciesApi.md index 26b3b99c..fe2edbf9 100644 --- a/auto-generated-sdk/docs/FrequenciesApi.md +++ b/auto-generated-sdk/docs/FrequenciesApi.md @@ -5,96 +5,10 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_pa_frequencies**](FrequenciesApi.md#get_pa_frequencies) | **GET** /analytics/engines/pa/v3/frequencies | Get PA frequencies [**get_spar_frequencies**](FrequenciesApi.md#get_spar_frequencies) | **GET** /analytics/engines/spar/v3/frequencies | Get SPAR frequencies [**get_vault_frequencies**](FrequenciesApi.md#get_vault_frequencies) | **GET** /analytics/engines/vault/v3/frequencies | Get Vault frequencies -# **get_pa_frequencies** -> FrequencyRoot get_pa_frequencies() - -Get PA frequencies - -This endpoint lists all the frequencies that can be applied to a PA calculation. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import frequencies_api -from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = frequencies_api.FrequenciesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # Get PA frequencies - api_response = api_instance.get_pa_frequencies() - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling FrequenciesApi->get_pa_frequencies: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**FrequencyRoot**](FrequencyRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_spar_frequencies** > FrequencyRoot get_spar_frequencies() diff --git a/auto-generated-sdk/docs/Group.md b/auto-generated-sdk/docs/Group.md deleted file mode 100644 index d9b4ac4b..00000000 --- a/auto-generated-sdk/docs/Group.md +++ /dev/null @@ -1,13 +0,0 @@ -# Group - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Group Name | [optional] -**directory** | **str** | Group Directory | [optional] -**category** | **str** | Group Category | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/GroupRoot.md b/auto-generated-sdk/docs/GroupRoot.md deleted file mode 100644 index 5e4fa466..00000000 --- a/auto-generated-sdk/docs/GroupRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (Group,)}**](Group.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/GroupsApi.md b/auto-generated-sdk/docs/GroupsApi.md deleted file mode 100644 index 859b236b..00000000 --- a/auto-generated-sdk/docs/GroupsApi.md +++ /dev/null @@ -1,181 +0,0 @@ - -# fds.analyticsapi.engines.GroupsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_pa_grouping_frequencies**](GroupsApi.md#get_pa_grouping_frequencies) | **GET** /analytics/engines/pa/v3/grouping-frequencies | Get PA grouping frequencies -[**get_pa_groups**](GroupsApi.md#get_pa_groups) | **GET** /analytics/engines/pa/v3/groups | Get PA groups - - -# **get_pa_grouping_frequencies** -> FrequencyRoot get_pa_grouping_frequencies() - -Get PA grouping frequencies - -This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import groups_api -from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = groups_api.GroupsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # Get PA grouping frequencies - api_response = api_instance.get_pa_grouping_frequencies() - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling GroupsApi->get_pa_grouping_frequencies: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**FrequencyRoot**](FrequencyRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of PA grouping 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pa_groups** -> GroupRoot get_pa_groups() - -Get PA groups - -This endpoint lists all the PA groups that can be applied to a PA calculation. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import groups_api -from fds.analyticsapi.engines.model.group_root import GroupRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = groups_api.GroupsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # Get PA groups - api_response = api_instance.get_pa_groups() - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling GroupsApi->get_pa_groups: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**GroupRoot**](GroupRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/LinkedPATemplate.md b/auto-generated-sdk/docs/LinkedPATemplate.md deleted file mode 100644 index 1de1b491..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplate.md +++ /dev/null @@ -1,17 +0,0 @@ -# LinkedPATemplate - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**directory** | **str** | Template directory. | [optional] -**snapshot** | **bool** | snapshot. | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] -**id** | **str** | Template id. | [optional] -**description** | **str** | Template description. | [optional] -**name** | **str** | Template name. | [optional] -**parent_component_id** | **str** | Template parent tile. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateParameters.md deleted file mode 100644 index 8cb94bd8..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateParameters.md +++ /dev/null @@ -1,14 +0,0 @@ -# LinkedPATemplateParameters - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**directory** | **str** | The directory to create a linked PA template | -**parent_component_id** | **str** | Parent component id | -**description** | **str** | Template description | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md deleted file mode 100644 index d44c9d1c..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedPATemplateParametersRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**LinkedPATemplateParameters**](LinkedPATemplateParameters.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md deleted file mode 100644 index 7fddec54..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md +++ /dev/null @@ -1,14 +0,0 @@ -# LinkedPATemplatePostSummary - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Template id. | [optional] -**description** | **str** | Template description. | [optional] -**name** | **str** | Template name. | [optional] -**parent_component_id** | **str** | Template parent tile. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md deleted file mode 100644 index fe14ecb4..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedPATemplatePostSummaryRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**LinkedPATemplatePostSummary**](LinkedPATemplatePostSummary.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateRoot.md b/auto-generated-sdk/docs/LinkedPATemplateRoot.md deleted file mode 100644 index ceffbce9..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedPATemplateRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**LinkedPATemplate**](LinkedPATemplate.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummary.md b/auto-generated-sdk/docs/LinkedPATemplateSummary.md deleted file mode 100644 index a4215a1a..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateSummary.md +++ /dev/null @@ -1,13 +0,0 @@ -# LinkedPATemplateSummary - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Template description. | [optional] -**name** | **str** | Template name. | [optional] -**parent_component_id** | **str** | Template parent tile. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md deleted file mode 100644 index 1aeb776c..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedPATemplateSummaryRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (LinkedPATemplateSummary,)}**](LinkedPATemplateSummary.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md deleted file mode 100644 index 822eed8b..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md +++ /dev/null @@ -1,13 +0,0 @@ -# LinkedPATemplateUpdateParameters - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parent_component_id** | **str** | Parent component id | [optional] -**description** | **str** | Template description | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md deleted file mode 100644 index e9f957f4..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedPATemplateUpdateParametersRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**LinkedPATemplateUpdateParameters**](LinkedPATemplateUpdateParameters.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/LinkedPATemplatesApi.md b/auto-generated-sdk/docs/LinkedPATemplatesApi.md deleted file mode 100644 index 326451ed..00000000 --- a/auto-generated-sdk/docs/LinkedPATemplatesApi.md +++ /dev/null @@ -1,516 +0,0 @@ - -# fds.analyticsapi.engines.LinkedPATemplatesApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_linked_pa_templates**](LinkedPATemplatesApi.md#create_linked_pa_templates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template -[**delete_linked_pa_templates**](LinkedPATemplatesApi.md#delete_linked_pa_templates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. -[**get_linked_pa_templates**](LinkedPATemplatesApi.md#get_linked_pa_templates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates -[**get_linked_pa_templates_by_id**](LinkedPATemplatesApi.md#get_linked_pa_templates_by_id) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id -[**update_linked_pa_templates**](LinkedPATemplatesApi.md#update_linked_pa_templates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template - - -# **create_linked_pa_templates** -> LinkedPATemplatePostSummaryRoot create_linked_pa_templates(linked_pa_template_parameters_root) - -Create a linked PA template - -This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import linked_pa_templates_api -from fds.analyticsapi.engines.model.linked_pa_template_post_summary_root import LinkedPATemplatePostSummaryRoot -from fds.analyticsapi.engines.model.linked_pa_template_parameters_root import LinkedPATemplateParametersRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) - linked_pa_template_parameters_root = LinkedPATemplateParametersRoot( - data=LinkedPATemplateParameters( - directory="directory_example", - parent_component_id="parent_component_id_example", - description="description_example", - content=TemplateContentTypes( - mandatory=[ - "mandatory_example", - ], - optional=[ - "optional_example", - ], - locked=[ - "locked_example", - ], - ), - ), - meta=None, - ) # LinkedPATemplateParametersRoot | Request Parameters - - # example passing only required values which don't have defaults set - try: - # Create a linked PA template - api_response = api_instance.create_linked_pa_templates(linked_pa_template_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling LinkedPATemplatesApi->create_linked_pa_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **linked_pa_template_parameters_root** | [**LinkedPATemplateParametersRoot**](LinkedPATemplateParametersRoot.md)| Request Parameters | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Expected response, created a template linked to a PA3 tile. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_linked_pa_templates** -> delete_linked_pa_templates(id) - -Delete a linked PA template. - -This endpoint deletes an existing linked PA template. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import linked_pa_templates_api -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for a linked PA template - - # example passing only required values which don't have defaults set - try: - # Delete a linked PA template. - api_instance.delete_linked_pa_templates(id) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling LinkedPATemplatesApi->delete_linked_pa_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for a linked PA template | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: None (empty response body) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Expected response, deleted the linked PA template successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_linked_pa_templates** -> LinkedPATemplateSummaryRoot get_linked_pa_templates() - -Get linked PA templates - -This endpoint returns the list of linked PA templates in given path. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import linked_pa_templates_api -from fds.analyticsapi.engines.model.linked_pa_template_summary_root import LinkedPATemplateSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) - directory = "Personal:LinkedPATemplates/" # str | Get linked PA templates in path. (optional) - document_directory = "documentDirectory_example" # str | Get linked PA templates for documents in document path (optional) - document_name = "documentName_example" # str | Get linked PA templates for documents by document name (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get linked PA templates - api_response = api_instance.get_linked_pa_templates(directory=directory, document_directory=document_directory, document_name=document_name) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling LinkedPATemplatesApi->get_linked_pa_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **directory** | **str**| Get linked PA templates in path. | [optional] - **document_directory** | **str**| Get linked PA templates for documents in document path | [optional] - **document_name** | **str**| Get linked PA templates for documents by document name | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**LinkedPATemplateSummaryRoot**](LinkedPATemplateSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of templates linked to PA3 tile. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Document not found | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_linked_pa_templates_by_id** -> LinkedPATemplateRoot get_linked_pa_templates_by_id(id) - -Get linked PA template by id - -This endpoint fetches the linked PA template settings. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import linked_pa_templates_api -from fds.analyticsapi.engines.model.linked_pa_template_root import LinkedPATemplateRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for a linked PA template - - # example passing only required values which don't have defaults set - try: - # Get linked PA template by id - api_response = api_instance.get_linked_pa_templates_by_id(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling LinkedPATemplatesApi->get_linked_pa_templates_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for a linked PA template | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**LinkedPATemplateRoot**](LinkedPATemplateRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, linked PA template details. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_linked_pa_templates** -> LinkedPATemplatePostSummaryRoot update_linked_pa_templates(id, linked_pa_template_update_parameters_root) - -Update a linked PA template - -This endpoint allows the user to change the request body and description from an existing template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import linked_pa_templates_api -from fds.analyticsapi.engines.model.linked_pa_template_post_summary_root import LinkedPATemplatePostSummaryRoot -from fds.analyticsapi.engines.model.linked_pa_template_update_parameters_root import LinkedPATemplateUpdateParametersRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for a linked PA template - linked_pa_template_update_parameters_root = LinkedPATemplateUpdateParametersRoot( - data=LinkedPATemplateUpdateParameters( - parent_component_id="parent_component_id_example", - description="description_example", - content=TemplateContentTypes( - mandatory=[ - "mandatory_example", - ], - optional=[ - "optional_example", - ], - locked=[ - "locked_example", - ], - ), - ), - meta=None, - ) # LinkedPATemplateUpdateParametersRoot | Request Parameters - - # example passing only required values which don't have defaults set - try: - # Update a linked PA template - api_response = api_instance.update_linked_pa_templates(id, linked_pa_template_update_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling LinkedPATemplatesApi->update_linked_pa_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for a linked PA template | - **linked_pa_template_update_parameters_root** | [**LinkedPATemplateUpdateParametersRoot**](LinkedPATemplateUpdateParametersRoot.md)| Request Parameters | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, updated a template linked to a PA3 tile. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Template or component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/PACalculationColumn.md b/auto-generated-sdk/docs/PACalculationColumn.md deleted file mode 100644 index 68855975..00000000 --- a/auto-generated-sdk/docs/PACalculationColumn.md +++ /dev/null @@ -1,12 +0,0 @@ -# PACalculationColumn - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | FactSet-defined or User-defined Column identifier. | [optional] -**statistics** | **[str]** | Column Statistic identifier | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACalculationDataSources.md b/auto-generated-sdk/docs/PACalculationDataSources.md deleted file mode 100644 index 278a015d..00000000 --- a/auto-generated-sdk/docs/PACalculationDataSources.md +++ /dev/null @@ -1,13 +0,0 @@ -# PACalculationDataSources - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**portfoliopricingsources** | [**[PACalculationPricingSource]**](PACalculationPricingSource.md) | List of portfilio pricing source for the PA calculation | [optional] -**benchmarkpricingsources** | [**[PACalculationPricingSource]**](PACalculationPricingSource.md) | List of benchmark pricing source for the PA calculation | [optional] -**useportfoliopricingsourcesforbenchmark** | **bool** | Use portfolio pricing sources for benchmark | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACalculationGroup.md b/auto-generated-sdk/docs/PACalculationGroup.md deleted file mode 100644 index 3c23cb3a..00000000 --- a/auto-generated-sdk/docs/PACalculationGroup.md +++ /dev/null @@ -1,12 +0,0 @@ -# PACalculationGroup - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | FactSet-defined or User-defined Group identifier. | [optional] -**frequency** | **str** | Grouping frequency | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACalculationParameters.md b/auto-generated-sdk/docs/PACalculationParameters.md deleted file mode 100644 index d2bc59ab..00000000 --- a/auto-generated-sdk/docs/PACalculationParameters.md +++ /dev/null @@ -1,19 +0,0 @@ -# PACalculationParameters - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**componentid** | **str** | The PA Engine component identifier to analyze. | -**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts. | [optional] -**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks. | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] -**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] -**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**componentdetail** | **str** | Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACalculationParametersRoot.md b/auto-generated-sdk/docs/PACalculationParametersRoot.md deleted file mode 100644 index 8126d6bb..00000000 --- a/auto-generated-sdk/docs/PACalculationParametersRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# PACalculationParametersRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (PACalculationParameters,)}**](PACalculationParameters.md) | List of calculation parameters. | [optional] -**meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACalculationPricingSource.md b/auto-generated-sdk/docs/PACalculationPricingSource.md deleted file mode 100644 index 47324096..00000000 --- a/auto-generated-sdk/docs/PACalculationPricingSource.md +++ /dev/null @@ -1,11 +0,0 @@ -# PACalculationPricingSource - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Pricing source identifier | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACalculationsApi.md b/auto-generated-sdk/docs/PACalculationsApi.md deleted file mode 100644 index 3d7f0cc9..00000000 --- a/auto-generated-sdk/docs/PACalculationsApi.md +++ /dev/null @@ -1,799 +0,0 @@ - -# fds.analyticsapi.engines.PACalculationsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**cancel_calculation_by_id**](PACalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id -[**get_all_calculations**](PACalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations -[**get_calculation_parameters**](PACalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id -[**get_calculation_status_by_id**](PACalculationsApi.md#get_calculation_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id -[**get_calculation_unit_result_by_id**](PACalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id -[**post_and_calculate**](PACalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation -[**put_and_calculate**](PACalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. - - -# **cancel_calculation_by_id** -> cancel_calculation_by_id(id) - -Cancel PA calculation by id - -This is the endpoint to cancel a previously submitted calculation. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Create and Run PA calculation endpoint - - # example passing only required values which don't have defaults set - try: - # Cancel PA calculation by id - api_instance.cancel_calculation_by_id(id) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->cancel_calculation_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Create and Run PA calculation endpoint | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: None (empty response body) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Expected response, 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_calculations** -> CalculationsSummaryRoot get_all_calculations() - -Get all calculations - -This endpoints returns all calculation requests. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.calculations_summary_root import CalculationsSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - page_number = 1 # int | (optional) if omitted the server will use the default value of 1 - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all calculations - api_response = api_instance.get_all_calculations(page_number=page_number) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->get_all_calculations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **page_number** | **int**| | [optional] if omitted the server will use the default value of 1 - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**CalculationsSummaryRoot**](CalculationsSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid page number. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | No calculation found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_calculation_parameters** -> PACalculationParametersRoot get_calculation_parameters(id) - -Get PA calculation parameters by id - -This is the endpoint that returns the calculation parameters passed for a calculation. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Create and Run PA calculation endpoint - - # example passing only required values which don't have defaults set - try: - # Get PA calculation parameters by id - api_response = api_instance.get_calculation_parameters(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->get_calculation_parameters: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Create and Run PA calculation endpoint | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**PACalculationParametersRoot**](PACalculationParametersRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns the PA calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Calculation 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_calculation_status_by_id** -> CalculationStatusRoot get_calculation_status_by_id(id) - -Get PA calculation status by id - -This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the location header will point to the result url. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.calculation_status_root import CalculationStatusRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Create and Run PA calculation endpoint - - # example passing only required values which don't have defaults set - try: - # Get PA calculation status by id - api_response = api_instance.get_calculation_status_by_id(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->get_calculation_status_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Create and Run PA calculation endpoint | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**CalculationStatusRoot**](CalculationStatusRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response once calculation is completed. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_calculation_unit_result_by_id** -> ObjectRoot get_calculation_unit_result_by_id(id, unit_id) - -Get PA calculation result by id - -This is the endpoint to get the result of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.object_root import ObjectRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Get PA calculation status by id endpoint - unit_id = "unitId_example" # str | from url, provided from the location header in the Get PA calculation status by id endpoint - - # example passing only required values which don't have defaults set - try: - # Get PA calculation result by id - api_response = api_instance.get_calculation_unit_result_by_id(id, unit_id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->get_calculation_unit_result_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Get PA calculation status by id endpoint | - **unit_id** | **str**| from url, provided from the location header in the Get PA calculation status by id endpoint | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**ObjectRoot**](ObjectRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, application/x-protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **post_and_calculate** -> CalculationStatusRoot post_and_calculate() - -Create and Run PA calculation - -This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.calculation_status_root import CalculationStatusRoot -from fds.analyticsapi.engines.model.object_root import ObjectRoot -from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) - cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional) - pa_calculation_parameters_root = PACalculationParametersRoot( - data={ - "key": PACalculationParameters( - componentid="componentid_example", - accounts=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - benchmarks=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - dates=PADateParameters( - startdate="startdate_example", - enddate="enddate_example", - frequency="frequency_example", - ), - groups=[ - PACalculationGroup( - id="id_example", - frequency="frequency_example", - ), - ], - currencyisocode="currencyisocode_example", - columns=[ - PACalculationColumn( - id="id_example", - statistics=[ - "statistics_example", - ], - ), - ], - datasources=PACalculationDataSources( - portfoliopricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - benchmarkpricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - useportfoliopricingsourcesforbenchmark=True, - ), - componentdetail="componentdetail_example", - ), - }, - meta=CalculationMeta( - contentorganization="SimplifiedRow", - stach_content_organization="SimplifiedRow", - contenttype="Json", - format="JsonStach", - ), - ) # PACalculationParametersRoot | Calculation Parameters (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Create and Run PA calculation - api_response = api_instance.post_and_calculate(x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, pa_calculation_parameters_root=pa_calculation_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->post_and_calculate: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] - **cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional] - **pa_calculation_parameters_root** | [**PACalculationParametersRoot**](PACalculationParametersRoot.md)| Calculation Parameters | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/x-protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **put_and_calculate** -> CalculationStatusRoot put_and_calculate(id) - -Create or Update PA calculation and run it. - -This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.calculation_status_root import CalculationStatusRoot -from fds.analyticsapi.engines.model.object_root import ObjectRoot -from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - id = "id_example" # str | from url, provided from the location header in the Create and Run PA calculation endpoint - x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation (optional) - cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional) - pa_calculation_parameters_root = PACalculationParametersRoot( - data={ - "key": PACalculationParameters( - componentid="componentid_example", - accounts=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - benchmarks=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - dates=PADateParameters( - startdate="startdate_example", - enddate="enddate_example", - frequency="frequency_example", - ), - groups=[ - PACalculationGroup( - id="id_example", - frequency="frequency_example", - ), - ], - currencyisocode="currencyisocode_example", - columns=[ - PACalculationColumn( - id="id_example", - statistics=[ - "statistics_example", - ], - ), - ], - datasources=PACalculationDataSources( - portfoliopricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - benchmarkpricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - useportfoliopricingsourcesforbenchmark=True, - ), - componentdetail="componentdetail_example", - ), - }, - meta=CalculationMeta( - contentorganization="SimplifiedRow", - stach_content_organization="SimplifiedRow", - contenttype="Json", - format="JsonStach", - ), - ) # PACalculationParametersRoot | Calculation Parameters (optional) - - # example passing only required values which don't have defaults set - try: - # Create or Update PA calculation and run it. - api_response = api_instance.put_and_calculate(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->put_and_calculate: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Create or Update PA calculation and run it. - api_response = api_instance.put_and_calculate(id, x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, pa_calculation_parameters_root=pa_calculation_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->put_and_calculate: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| from url, provided from the location header in the Create and Run PA calculation endpoint | - **x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation | [optional] - **cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional] - **pa_calculation_parameters_root** | [**PACalculationParametersRoot**](PACalculationParametersRoot.md)| Calculation Parameters | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md)) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/x-protobuf - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid Calculation Parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/PAComponent.md b/auto-generated-sdk/docs/PAComponent.md deleted file mode 100644 index 0654c288..00000000 --- a/auto-generated-sdk/docs/PAComponent.md +++ /dev/null @@ -1,19 +0,0 @@ -# PAComponent - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Component identifier. | [optional] -**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts saved in the PA document. | [optional] -**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks saved in the PA document. | [optional] -**currencyisocode** | **str** | | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**snapshot** | **bool** | Is the component type snapshot or subperiod. | [optional] -**path** | **str** | The path to the document | [optional] -**name** | **str** | Component name. | [optional] -**category** | **str** | Component category. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PAComponentData.md b/auto-generated-sdk/docs/PAComponentData.md deleted file mode 100644 index 24ce86d3..00000000 --- a/auto-generated-sdk/docs/PAComponentData.md +++ /dev/null @@ -1,18 +0,0 @@ -# PAComponentData - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts. | [optional] -**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks. | [optional] -**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] -**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] -**componentdetail** | **str** | PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PAComponentRoot.md b/auto-generated-sdk/docs/PAComponentRoot.md deleted file mode 100644 index a8a79133..00000000 --- a/auto-generated-sdk/docs/PAComponentRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# PAComponentRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**PAComponent**](PAComponent.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PADateParameters.md b/auto-generated-sdk/docs/PADateParameters.md deleted file mode 100644 index 150bd42b..00000000 --- a/auto-generated-sdk/docs/PADateParameters.md +++ /dev/null @@ -1,14 +0,0 @@ -# PADateParameters - -The date parameters for PA calculation. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**enddate** | **str** | Calculation's end date. | -**frequency** | **str** | Calculation's frequency. | -**startdate** | **str** | Calculation's start date. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PAIdentifier.md b/auto-generated-sdk/docs/PAIdentifier.md deleted file mode 100644 index c6a97658..00000000 --- a/auto-generated-sdk/docs/PAIdentifier.md +++ /dev/null @@ -1,12 +0,0 @@ -# PAIdentifier - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | User's FactSet account path OR benchmark. | -**holdingsmode** | **str** | Holdings Mode can be B&H, TBR, OMS , EXT or VLT. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PAPricingSource.md b/auto-generated-sdk/docs/PAPricingSource.md deleted file mode 100644 index fb4ce976..00000000 --- a/auto-generated-sdk/docs/PAPricingSource.md +++ /dev/null @@ -1,13 +0,0 @@ -# PAPricingSource - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Pricing source Name | [optional] -**directory** | **str** | Pricing source directory | [optional] -**category** | **str** | Pricing source category | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PAPricingSourceRoot.md b/auto-generated-sdk/docs/PAPricingSourceRoot.md deleted file mode 100644 index a0e9962a..00000000 --- a/auto-generated-sdk/docs/PAPricingSourceRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# PAPricingSourceRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (PAPricingSource,)}**](PAPricingSource.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PaDoc.md b/auto-generated-sdk/docs/PaDoc.md deleted file mode 100644 index c7ddabd9..00000000 --- a/auto-generated-sdk/docs/PaDoc.md +++ /dev/null @@ -1,11 +0,0 @@ -# PaDoc - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | PA document path | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PubCalculationsApi.md b/auto-generated-sdk/docs/PubCalculationsApi.md index 2e0dfef0..b47ea54c 100644 --- a/auto-generated-sdk/docs/PubCalculationsApi.md +++ b/auto-generated-sdk/docs/PubCalculationsApi.md @@ -86,7 +86,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -451,7 +451,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/x-protobuf, application/pdf + - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/json ### HTTP response details @@ -459,9 +459,9 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Expected response once calculation is completed, returns result in the format specified in the Calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| @@ -553,7 +553,7 @@ Name | Type | Description | Notes ### Return type - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File ) + - **Response datatype**: (For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) ### Authorization @@ -562,19 +562,19 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation + - **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **400** | Invalid calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| @@ -678,7 +678,7 @@ Name | Type | Description | Notes ### Return type - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File ) + - **Response datatype**: (For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) ### Authorization @@ -687,20 +687,20 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/pdf + - **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation ### 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **400** | Invalid Calculation Parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* 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/QuantCalculationsApi.md b/auto-generated-sdk/docs/QuantCalculationsApi.md index 81254f68..45cbef11 100644 --- a/auto-generated-sdk/docs/QuantCalculationsApi.md +++ b/auto-generated-sdk/docs/QuantCalculationsApi.md @@ -87,7 +87,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details diff --git a/auto-generated-sdk/docs/QuantDateListObsolete.md b/auto-generated-sdk/docs/QuantDateListObsolete.md deleted file mode 100644 index 38769883..00000000 --- a/auto-generated-sdk/docs/QuantDateListObsolete.md +++ /dev/null @@ -1,14 +0,0 @@ -# QuantDateListObsolete - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**frequency** | **str** | | -**calendar** | **str** | | -**dates** | **[str]** | | [optional] -**override_universal_screen_calendar** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/QuantFdsDateObsolete.md b/auto-generated-sdk/docs/QuantFdsDateObsolete.md deleted file mode 100644 index 6d9504f0..00000000 --- a/auto-generated-sdk/docs/QuantFdsDateObsolete.md +++ /dev/null @@ -1,15 +0,0 @@ -# QuantFdsDateObsolete - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_date** | **str** | | -**end_date** | **str** | | -**frequency** | **str** | | -**calendar** | **str** | | -**override_universal_screen_calendar** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md b/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md deleted file mode 100644 index 901dc206..00000000 --- a/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md +++ /dev/null @@ -1,14 +0,0 @@ -# QuantFqlExpressionObsolete - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**expr** | **str** | | -**name** | **str** | | -**date_offset** | **str** | | [optional] -**is_array_return_type** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md b/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md deleted file mode 100644 index 07b169f3..00000000 --- a/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md +++ /dev/null @@ -1,13 +0,0 @@ -# QuantIdentifierUniverseObsolete - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**universe_type** | **str** | | -**identifiers** | **[str]** | | -**source** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md b/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md deleted file mode 100644 index 029cc39e..00000000 --- a/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md +++ /dev/null @@ -1,13 +0,0 @@ -# QuantScreeningExpressionObsolete - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**expr** | **str** | | -**name** | **str** | | -**date_offset** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md b/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md deleted file mode 100644 index f7bcdddc..00000000 --- a/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md +++ /dev/null @@ -1,14 +0,0 @@ -# QuantScreeningExpressionUniverseObsolete - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**universe_expr** | **str** | | -**universe_type** | **str** | | -**security_expr** | **str** | | [optional] -**source** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md b/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md deleted file mode 100644 index 025fad24..00000000 --- a/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md +++ /dev/null @@ -1,12 +0,0 @@ -# QuantUniversalScreenParameterObsolete - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reference_name** | **str** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md b/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md deleted file mode 100644 index 87227b51..00000000 --- a/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md +++ /dev/null @@ -1,12 +0,0 @@ -# QuantUniversalScreenUniverseObsolete - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**screen** | **str** | | -**source** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/SPARCalculationsApi.md b/auto-generated-sdk/docs/SPARCalculationsApi.md index a1a79c1a..c546aa0f 100644 --- a/auto-generated-sdk/docs/SPARCalculationsApi.md +++ b/auto-generated-sdk/docs/SPARCalculationsApi.md @@ -86,7 +86,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details @@ -536,6 +536,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: startdate="startdate_example", enddate="enddate_example", frequency="frequency_example", + useeachportfolioinception=True, ), currencyisocode="currencyisocode_example", ), @@ -668,6 +669,7 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: startdate="startdate_example", enddate="enddate_example", frequency="frequency_example", + useeachportfolioinception=True, ), currencyisocode="currencyisocode_example", ), diff --git a/auto-generated-sdk/docs/SPARDateParameters.md b/auto-generated-sdk/docs/SPARDateParameters.md index b713beff..a3d38ebb 100644 --- a/auto-generated-sdk/docs/SPARDateParameters.md +++ b/auto-generated-sdk/docs/SPARDateParameters.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **startdate** | **str** | Calculation's start date. | **enddate** | **str** | Calculation's end date. | **frequency** | **str** | Calculation's frequency. | +**useeachportfolioinception** | **bool** | Use Each Portfolio Inception | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/StrategyDocumentsApi.md b/auto-generated-sdk/docs/StrategyDocumentsApi.md index 1fb0f9eb..82371efd 100644 --- a/auto-generated-sdk/docs/StrategyDocumentsApi.md +++ b/auto-generated-sdk/docs/StrategyDocumentsApi.md @@ -8,7 +8,6 @@ Method | HTTP request | Description [**get_axioma_equity_strategy_documents**](StrategyDocumentsApi.md#get_axioma_equity_strategy_documents) | **GET** /analytics/engines/axp/v3/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory [**get_axioma_fi_strategy_documents**](StrategyDocumentsApi.md#get_axioma_fi_strategy_documents) | **GET** /analytics/engines/afi/v3/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory [**get_barra_strategy_documents**](StrategyDocumentsApi.md#get_barra_strategy_documents) | **GET** /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory -[**get_fpo_strategy_documents**](StrategyDocumentsApi.md#get_fpo_strategy_documents) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory [**get_northfield_strategy_documents**](StrategyDocumentsApi.md#get_northfield_strategy_documents) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory @@ -288,98 +287,6 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_fpo_strategy_documents** -> DocumentDirectoriesRoot get_fpo_strategy_documents(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 - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import strategy_documents_api -from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = strategy_documents_api.StrategyDocumentsApi(api_client) - path = "Client:" # str | The directory to get the strategy documents and sub-directories in - - # example passing only required values which don't have defaults set - try: - # Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory - api_response = api_instance.get_fpo_strategy_documents(path) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling StrategyDocumentsApi->get_fpo_strategy_documents: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str**| The directory to get the strategy documents and sub-directories in | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**DocumentDirectoriesRoot**](DocumentDirectoriesRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in 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.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_northfield_strategy_documents** > DocumentDirectoriesRoot get_northfield_strategy_documents(path) diff --git a/auto-generated-sdk/docs/TemplateContentTypes.md b/auto-generated-sdk/docs/TemplateContentTypes.md deleted file mode 100644 index 7a747e3d..00000000 --- a/auto-generated-sdk/docs/TemplateContentTypes.md +++ /dev/null @@ -1,13 +0,0 @@ -# TemplateContentTypes - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mandatory** | **[str]** | Template mandatory fields | [optional] -**optional** | **[str]** | Template optional fields | [optional] -**locked** | **[str]** | Template locked fields | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponent.md b/auto-generated-sdk/docs/TemplatedPAComponent.md deleted file mode 100644 index e42c9a06..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponent.md +++ /dev/null @@ -1,18 +0,0 @@ -# TemplatedPAComponent - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**directory** | **str** | | [optional] -**snapshot** | **bool** | | [optional] -**component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] -**description** | **str** | | [optional] -**name** | **str** | | [optional] -**parent_template_id** | **str** | | [optional] -**type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentParameters.md deleted file mode 100644 index 8391fd05..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentParameters.md +++ /dev/null @@ -1,14 +0,0 @@ -# TemplatedPAComponentParameters - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**directory** | **str** | Directory to create templated components | -**parent_template_id** | **str** | Parent template id | -**description** | **str** | Component description. | [optional] -**component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md deleted file mode 100644 index aee281d5..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemplatedPAComponentParametersRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**TemplatedPAComponentParameters**](TemplatedPAComponentParameters.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md deleted file mode 100644 index ad05cdb3..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md +++ /dev/null @@ -1,15 +0,0 @@ -# TemplatedPAComponentPostSummary - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**description** | **str** | | [optional] -**name** | **str** | | [optional] -**parent_template_id** | **str** | | [optional] -**type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md deleted file mode 100644 index 781f6e18..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemplatedPAComponentPostSummaryRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**TemplatedPAComponentPostSummary**](TemplatedPAComponentPostSummary.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentRoot.md deleted file mode 100644 index 26ec1284..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemplatedPAComponentRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**TemplatedPAComponent**](TemplatedPAComponent.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentSummary.md deleted file mode 100644 index f6f921a0..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentSummary.md +++ /dev/null @@ -1,14 +0,0 @@ -# TemplatedPAComponentSummary - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**name** | **str** | | [optional] -**parent_template_id** | **str** | | [optional] -**type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md deleted file mode 100644 index 0091253b..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemplatedPAComponentSummaryRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (TemplatedPAComponentSummary,)}**](TemplatedPAComponentSummary.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md deleted file mode 100644 index f5279b80..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md +++ /dev/null @@ -1,13 +0,0 @@ -# TemplatedPAComponentUpdateParameters - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parent_template_id** | **str** | Parent template id | [optional] -**description** | **str** | Component description. | [optional] -**component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md deleted file mode 100644 index 47a5ae0b..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemplatedPAComponentUpdateParametersRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**TemplatedPAComponentUpdateParameters**](TemplatedPAComponentUpdateParameters.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentsApi.md b/auto-generated-sdk/docs/TemplatedPAComponentsApi.md deleted file mode 100644 index e9050ce3..00000000 --- a/auto-generated-sdk/docs/TemplatedPAComponentsApi.md +++ /dev/null @@ -1,584 +0,0 @@ - -# fds.analyticsapi.engines.TemplatedPAComponentsApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_templated_pa_components**](TemplatedPAComponentsApi.md#create_templated_pa_components) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component -[**delete_templated_pa_components**](TemplatedPAComponentsApi.md#delete_templated_pa_components) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component -[**get_templated_pa_component_by_id**](TemplatedPAComponentsApi.md#get_templated_pa_component_by_id) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id -[**get_templated_pa_components_in_path**](TemplatedPAComponentsApi.md#get_templated_pa_components_in_path) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path -[**update_templated_pa_components**](TemplatedPAComponentsApi.md#update_templated_pa_components) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component - - -# **create_templated_pa_components** -> TemplatedPAComponentPostSummaryRoot create_templated_pa_components(templated_pa_component_parameters_root) - -Create templated PA component - -This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import templated_pa_components_api -from fds.analyticsapi.engines.model.templated_pa_component_post_summary_root import TemplatedPAComponentPostSummaryRoot -from fds.analyticsapi.engines.model.templated_pa_component_parameters_root import TemplatedPAComponentParametersRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) - templated_pa_component_parameters_root = TemplatedPAComponentParametersRoot( - data=TemplatedPAComponentParameters( - directory="directory_example", - parent_template_id="parent_template_id_example", - description="description_example", - component_data=PAComponentData( - accounts=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - benchmarks=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - groups=[ - PACalculationGroup( - id="id_example", - frequency="frequency_example", - ), - ], - columns=[ - PACalculationColumn( - id="id_example", - statistics=[ - "statistics_example", - ], - ), - ], - dates=PADateParameters( - startdate="startdate_example", - enddate="enddate_example", - frequency="frequency_example", - ), - datasources=PACalculationDataSources( - portfoliopricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - benchmarkpricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - useportfoliopricingsourcesforbenchmark=True, - ), - currencyisocode="currencyisocode_example", - componentdetail="componentdetail_example", - ), - ), - meta=None, - ) # TemplatedPAComponentParametersRoot | Request Parameters - - # example passing only required values which don't have defaults set - try: - # Create templated PA component - api_response = api_instance.create_templated_pa_components(templated_pa_component_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling TemplatedPAComponentsApi->create_templated_pa_components: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **templated_pa_component_parameters_root** | [**TemplatedPAComponentParametersRoot**](TemplatedPAComponentParametersRoot.md)| Request Parameters | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Expected response, templated PA component created successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_templated_pa_components** -> delete_templated_pa_components(id) - -Delete templated PA component - -This endpoint deletes an existing templated PA component - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import templated_pa_components_api -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for a templated PA component - - # example passing only required values which don't have defaults set - try: - # Delete templated PA component - api_instance.delete_templated_pa_components(id) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling TemplatedPAComponentsApi->delete_templated_pa_components: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for a templated PA component | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: None (empty response body) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Expected response, deleted the templated PA component successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_templated_pa_component_by_id** -> TemplatedPAComponentRoot get_templated_pa_component_by_id(id) - -Get templated PA component by id - -This endpoint fetches the templated PA component settings. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import templated_pa_components_api -from fds.analyticsapi.engines.model.templated_pa_component_root import TemplatedPAComponentRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for a templated PA component - - # example passing only required values which don't have defaults set - try: - # Get templated PA component by id - api_response = api_instance.get_templated_pa_component_by_id(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling TemplatedPAComponentsApi->get_templated_pa_component_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for a templated PA component | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**TemplatedPAComponentRoot**](TemplatedPAComponentRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, templated PA component details. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Templated PA component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_templated_pa_components_in_path** -> TemplatedPAComponentSummaryRoot get_templated_pa_components_in_path(directory) - -Get templated PA components in path - -This endpoint returns the list of templated PA components in path. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import templated_pa_components_api -from fds.analyticsapi.engines.model.templated_pa_component_summary_root import TemplatedPAComponentSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) - directory = "Personal:TemplatedPAComponents/" # str | Get templated PA components in path - - # example passing only required values which don't have defaults set - try: - # Get templated PA components in path - api_response = api_instance.get_templated_pa_components_in_path(directory) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling TemplatedPAComponentsApi->get_templated_pa_components_in_path: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **directory** | **str**| Get templated PA components in path | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**TemplatedPAComponentSummaryRoot**](TemplatedPAComponentSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list templated PA components. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_templated_pa_components** -> TemplatedPAComponentPostSummaryRoot update_templated_pa_components(id, templated_pa_component_update_parameters_root) - -Update templated PA component - -This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import templated_pa_components_api -from fds.analyticsapi.engines.model.templated_pa_component_post_summary_root import TemplatedPAComponentPostSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.templated_pa_component_update_parameters_root import TemplatedPAComponentUpdateParametersRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for a templated PA component - templated_pa_component_update_parameters_root = TemplatedPAComponentUpdateParametersRoot( - data=TemplatedPAComponentUpdateParameters( - parent_template_id="parent_template_id_example", - description="description_example", - component_data=PAComponentData( - accounts=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - benchmarks=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - groups=[ - PACalculationGroup( - id="id_example", - frequency="frequency_example", - ), - ], - columns=[ - PACalculationColumn( - id="id_example", - statistics=[ - "statistics_example", - ], - ), - ], - dates=PADateParameters( - startdate="startdate_example", - enddate="enddate_example", - frequency="frequency_example", - ), - datasources=PACalculationDataSources( - portfoliopricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - benchmarkpricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - useportfoliopricingsourcesforbenchmark=True, - ), - currencyisocode="currencyisocode_example", - componentdetail="componentdetail_example", - ), - ), - meta=None, - ) # TemplatedPAComponentUpdateParametersRoot | Request Parameters - - # example passing only required values which don't have defaults set - try: - # Update templated PA component - api_response = api_instance.update_templated_pa_components(id, templated_pa_component_update_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling TemplatedPAComponentsApi->update_templated_pa_components: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for a templated PA component | - **templated_pa_component_update_parameters_root** | [**TemplatedPAComponentUpdateParametersRoot**](TemplatedPAComponentUpdateParametersRoot.md)| Request Parameters | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, updated successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Component or template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplate.md b/auto-generated-sdk/docs/UnlinkedPATemplate.md deleted file mode 100644 index 222c2ce6..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplate.md +++ /dev/null @@ -1,26 +0,0 @@ -# UnlinkedPATemplate - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Template id. | [optional] -**directory** | **str** | Template directory. | [optional] -**template_type_id** | **str** | Template type id | [optional] -**snapshot** | **bool** | snapshot. | [optional] -**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] -**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] -**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] -**componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] -**description** | **str** | Template description. | [optional] -**name** | **str** | Template name. | [optional] -**category** | **str** | Unlinked template category | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md deleted file mode 100644 index 77d74bc4..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnlinkedPATemplateCategoryAndType - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** | **str** | Unlinked template category | [optional] -**name** | **str** | Unlinked template type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md deleted file mode 100644 index cb7e0fdb..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md +++ /dev/null @@ -1,16 +0,0 @@ -# UnlinkedPATemplateCategoryAndTypeDetails - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Type Id | [optional] -**columns** | [**[UnlinkedPATemplateColumnDetails]**](UnlinkedPATemplateColumnDetails.md) | List of default columns | [optional] -**groups** | [**[UnlinkedPATemplateGroupDetails]**](UnlinkedPATemplateGroupDetails.md) | List of default groupings | [optional] -**snapshot** | **bool** | Snapshot | [optional] -**category** | **str** | Unlinked template category | [optional] -**name** | **str** | Unlinked template type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md deleted file mode 100644 index d2843fff..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnlinkedPATemplateCategoryAndTypeDetailsRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplateCategoryAndTypeDetails**](UnlinkedPATemplateCategoryAndTypeDetails.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md deleted file mode 100644 index aa32d0f2..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnlinkedPATemplateCategoryAndTypeRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (UnlinkedPATemplateCategoryAndType,)}**](UnlinkedPATemplateCategoryAndType.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md deleted file mode 100644 index 6e724045..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnlinkedPATemplateColumnDetails - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Unlinked template column name | [optional] -**id** | **str** | FactSet-defined or User-defined Column identifier. | [optional] -**statistics** | **[str]** | Column Statistic identifier | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md deleted file mode 100644 index 6e718bb6..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnlinkedPATemplateGroupDetails - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Unlinked template group name | [optional] -**id** | **str** | FactSet-defined or User-defined Group identifier. | [optional] -**frequency** | **str** | Grouping frequency | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md deleted file mode 100644 index 910d3546..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md +++ /dev/null @@ -1,22 +0,0 @@ -# UnlinkedPATemplateParameters - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**directory** | **str** | The directory to create an unlinked PA template | -**template_type_id** | **str** | Template type id | -**description** | **str** | Template description | [optional] -**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] -**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] -**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] -**componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md deleted file mode 100644 index cc59019f..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnlinkedPATemplateParametersRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplateParameters**](UnlinkedPATemplateParameters.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md deleted file mode 100644 index 7746062b..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md +++ /dev/null @@ -1,14 +0,0 @@ -# UnlinkedPATemplatePostSummary - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Template id. | [optional] -**description** | **str** | Template description. | [optional] -**name** | **str** | Template name. | [optional] -**category** | **str** | Unlinked template category | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md deleted file mode 100644 index 3587cd0a..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnlinkedPATemplatePostSummaryRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplatePostSummary**](UnlinkedPATemplatePostSummary.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md deleted file mode 100644 index 6f5d01d5..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnlinkedPATemplateRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplate**](UnlinkedPATemplate.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md deleted file mode 100644 index ac05c7b2..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnlinkedPATemplateSummary - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Template description. | [optional] -**name** | **str** | Template name. | [optional] -**category** | **str** | Unlinked template category | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md deleted file mode 100644 index b198130f..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnlinkedPATemplateSummaryRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (UnlinkedPATemplateSummary,)}**](UnlinkedPATemplateSummary.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md deleted file mode 100644 index 73085202..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md +++ /dev/null @@ -1,20 +0,0 @@ -# UnlinkedPATemplateUpdateParameters - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Template description | [optional] -**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] -**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] -**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] -**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] -**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] -**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] -**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] -**componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] -**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md deleted file mode 100644 index 9ab97760..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnlinkedPATemplateUpdateParametersRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**UnlinkedPATemplateUpdateParameters**](UnlinkedPATemplateUpdateParameters.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md b/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md deleted file mode 100644 index e88cd7c2..00000000 --- a/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md +++ /dev/null @@ -1,782 +0,0 @@ - -# fds.analyticsapi.engines.UnlinkedPATemplatesApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_unlinked_pa_templates**](UnlinkedPATemplatesApi.md#create_unlinked_pa_templates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template -[**delete_unlinked_pa_templates**](UnlinkedPATemplatesApi.md#delete_unlinked_pa_templates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template -[**get_default_unlinked_pa_template_types**](UnlinkedPATemplatesApi.md#get_default_unlinked_pa_template_types) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. -[**get_details_type**](UnlinkedPATemplatesApi.md#get_details_type) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. -[**get_unlinked_pa_templates**](UnlinkedPATemplatesApi.md#get_unlinked_pa_templates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates -[**get_unlinked_pa_templates_by_id**](UnlinkedPATemplatesApi.md#get_unlinked_pa_templates_by_id) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id -[**update_unlinked_pa_templates**](UnlinkedPATemplatesApi.md#update_unlinked_pa_templates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template - - -# **create_unlinked_pa_templates** -> UnlinkedPATemplatePostSummaryRoot create_unlinked_pa_templates(unlinked_pa_template_parameters_root) - -Create unlinked PA template - -This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import unlinked_pa_templates_api -from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary_root import UnlinkedPATemplatePostSummaryRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_parameters_root import UnlinkedPATemplateParametersRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) - unlinked_pa_template_parameters_root = UnlinkedPATemplateParametersRoot( - data=UnlinkedPATemplateParameters( - directory="directory_example", - template_type_id="template_type_id_example", - description="description_example", - accounts=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - benchmarks=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - columns=[ - PACalculationColumn( - id="id_example", - statistics=[ - "statistics_example", - ], - ), - ], - dates=PADateParameters( - startdate="startdate_example", - enddate="enddate_example", - frequency="frequency_example", - ), - groups=[ - PACalculationGroup( - id="id_example", - frequency="frequency_example", - ), - ], - datasources=PACalculationDataSources( - portfoliopricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - benchmarkpricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - useportfoliopricingsourcesforbenchmark=True, - ), - currencyisocode="currencyisocode_example", - componentdetail="componentdetail_example", - content=TemplateContentTypes( - mandatory=[ - "mandatory_example", - ], - optional=[ - "optional_example", - ], - locked=[ - "locked_example", - ], - ), - ), - meta=None, - ) # UnlinkedPATemplateParametersRoot | Request Parameters - - # example passing only required values which don't have defaults set - try: - # Create unlinked PA template - api_response = api_instance.create_unlinked_pa_templates(unlinked_pa_template_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling UnlinkedPATemplatesApi->create_unlinked_pa_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **unlinked_pa_template_parameters_root** | [**UnlinkedPATemplateParametersRoot**](UnlinkedPATemplateParametersRoot.md)| Request Parameters | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Expected response, created a unlinked PA template. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_unlinked_pa_templates** -> delete_unlinked_pa_templates(id) - -Delete unlinked PA template - -This endpoint deletes an existing unliked PA template. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import unlinked_pa_templates_api -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for an unlinked PA template - - # example passing only required values which don't have defaults set - try: - # Delete unlinked PA template - api_instance.delete_unlinked_pa_templates(id) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling UnlinkedPATemplatesApi->delete_unlinked_pa_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for an unlinked PA template | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: None (empty response body) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Expected response, deleted the unlinked PA template successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_default_unlinked_pa_template_types** -> UnlinkedPATemplateCategoryAndTypeRoot get_default_unlinked_pa_template_types() - -Get default unlinked PA template types. - -This endpoint fetches default unlinked PA template types. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import unlinked_pa_templates_api -from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_root import UnlinkedPATemplateCategoryAndTypeRoot -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # Get default unlinked PA template types. - api_response = api_instance.get_default_unlinked_pa_template_types() - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling UnlinkedPATemplatesApi->get_default_unlinked_pa_template_types: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**UnlinkedPATemplateCategoryAndTypeRoot**](UnlinkedPATemplateCategoryAndTypeRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, default unlinked PA template types | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_details_type** -> UnlinkedPATemplateCategoryAndTypeDetailsRoot get_details_type(id) - -Get unlinked PA template type details by id. - -This endpoint fetches the unlinked PA template type details. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import unlinked_pa_templates_api -from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details_root import UnlinkedPATemplateCategoryAndTypeDetailsRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) - id = "id_example" # str | Unique identifier for an unlinked PA template type - - # example passing only required values which don't have defaults set - try: - # Get unlinked PA template type details by id. - api_response = api_instance.get_details_type(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling UnlinkedPATemplatesApi->get_details_type: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for an unlinked PA template type | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**UnlinkedPATemplateCategoryAndTypeDetailsRoot**](UnlinkedPATemplateCategoryAndTypeDetailsRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, details of the unlinked PA template type | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Unlinked PA template type not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_unlinked_pa_templates** -> UnlinkedPATemplateSummaryRoot get_unlinked_pa_templates() - -Get unlinked PA templates - -This endpoint returns the list of unlinked PA templates. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import unlinked_pa_templates_api -from fds.analyticsapi.engines.model.unlinked_pa_template_summary_root import UnlinkedPATemplateSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) - directory = "Personal:UninkedPATemplates/" # str | Get unlinked PA templates in path. (optional) - category = "Weights" # str | Get unlinked PA templates by category. (optional) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get unlinked PA templates - api_response = api_instance.get_unlinked_pa_templates(directory=directory, category=category) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling UnlinkedPATemplatesApi->get_unlinked_pa_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **directory** | **str**| Get unlinked PA templates in path. | [optional] - **category** | **str**| Get unlinked PA templates by category. | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**UnlinkedPATemplateSummaryRoot**](UnlinkedPATemplateSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a list of unlinked PA templates. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_unlinked_pa_templates_by_id** -> UnlinkedPATemplateRoot get_unlinked_pa_templates_by_id(id) - -Get unlinked PA template details by id - -This endpoint fetches the template settings. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import unlinked_pa_templates_api -from fds.analyticsapi.engines.model.unlinked_pa_template_root import UnlinkedPATemplateRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for an unlinked PA template - - # example passing only required values which don't have defaults set - try: - # Get unlinked PA template details by id - api_response = api_instance.get_unlinked_pa_templates_by_id(id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling UnlinkedPATemplatesApi->get_unlinked_pa_templates_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for an unlinked PA template | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**UnlinkedPATemplateRoot**](UnlinkedPATemplateRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, get details of the unlinked PA template. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_unlinked_pa_templates** -> UnlinkedPATemplatePostSummaryRoot update_unlinked_pa_templates(id, unlinked_pa_template_update_parameters_root) - -Update unlinked PA template - -This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import unlinked_pa_templates_api -from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters_root import UnlinkedPATemplateUpdateParametersRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary_root import UnlinkedPATemplatePostSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) - id = "01234567890123456789012345678901" # str | Unique identifier for an unlinked PA template - unlinked_pa_template_update_parameters_root = UnlinkedPATemplateUpdateParametersRoot( - data=UnlinkedPATemplateUpdateParameters( - description="description_example", - accounts=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - benchmarks=[ - PAIdentifier( - id="id_example", - holdingsmode="holdingsmode_example", - ), - ], - columns=[ - PACalculationColumn( - id="id_example", - statistics=[ - "statistics_example", - ], - ), - ], - dates=PADateParameters( - startdate="startdate_example", - enddate="enddate_example", - frequency="frequency_example", - ), - groups=[ - PACalculationGroup( - id="id_example", - frequency="frequency_example", - ), - ], - datasources=PACalculationDataSources( - portfoliopricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - benchmarkpricingsources=[ - PACalculationPricingSource( - id="id_example", - ), - ], - useportfoliopricingsourcesforbenchmark=True, - ), - currencyisocode="currencyisocode_example", - componentdetail="componentdetail_example", - content=TemplateContentTypes( - mandatory=[ - "mandatory_example", - ], - optional=[ - "optional_example", - ], - locked=[ - "locked_example", - ], - ), - ), - meta=None, - ) # UnlinkedPATemplateUpdateParametersRoot | Request Parameters - - # example passing only required values which don't have defaults set - try: - # Update unlinked PA template - api_response = api_instance.update_unlinked_pa_templates(id, unlinked_pa_template_update_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling UnlinkedPATemplatesApi->update_unlinked_pa_templates: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Unique identifier for an unlinked PA template | - **unlinked_pa_template_update_parameters_root** | [**UnlinkedPATemplateUpdateParametersRoot**](UnlinkedPATemplateUpdateParametersRoot.md)| Request Parameters | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, updated the unlinked PA template. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/PricingSourcesApi.md b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md similarity index 55% rename from auto-generated-sdk/docs/PricingSourcesApi.md rename to auto-generated-sdk/docs/VaultAttributionLoaderApi.md index 4c0668bb..6937cd61 100644 --- a/auto-generated-sdk/docs/PricingSourcesApi.md +++ b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md @@ -1,19 +1,19 @@ -# fds.analyticsapi.engines.PricingSourcesApi +# fds.analyticsapi.engines.VaultAttributionLoaderApi All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_pa_pricing_sources**](PricingSourcesApi.md#get_pa_pricing_sources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources +[**vault_attribution_loader**](VaultAttributionLoaderApi.md#vault_attribution_loader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader -# **get_pa_pricing_sources** -> PAPricingSourceRoot get_pa_pricing_sources() +# **vault_attribution_loader** +> VaultAttributionLoaderResponseRoot vault_attribution_loader(batch_id) -Get PA pricing sources +Vault - External Attribution Loader -This endpoint lists all the PA pricing sources that can be applied to a PA calculation. +This endpoint loads Vault External Attributions. ### Example @@ -22,8 +22,8 @@ This endpoint lists all the PA pricing sources that can be applied to a PA calcu ```python import time import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pricing_sources_api -from fds.analyticsapi.engines.model.pa_pricing_source_root import PAPricingSourceRoot +from fds.analyticsapi.engines.api import vault_attribution_loader_api +from fds.analyticsapi.engines.model.vault_attribution_loader_response_root import VaultAttributionLoaderResponseRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from pprint import pprint # Defining the host is optional and defaults to https://api.factset.com @@ -51,19 +51,26 @@ configuration = fds.analyticsapi.engines.Configuration( # Enter a context with an instance of the API client with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = pricing_sources_api.PricingSourcesApi(api_client) - name = "" # str | PA pricing sources name (optional) if omitted the server will use the default value of "" - category = "" # str | PA pricing sources category (optional) if omitted the server will use the default value of "" - directory = "" # str | The directory to get the PA pricing sources in (optional) if omitted the server will use the default value of "" + api_instance = vault_attribution_loader_api.VaultAttributionLoaderApi(api_client) + batch_id = "batchId_example" # str | + file = open('/path/to/file', 'rb') # file_type, none_type | (optional) + + # example passing only required values which don't have defaults set + try: + # Vault - External Attribution Loader + api_response = api_instance.vault_attribution_loader(batch_id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling VaultAttributionLoaderApi->vault_attribution_loader: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get PA pricing sources - api_response = api_instance.get_pa_pricing_sources(name=name, category=category, directory=directory) + # Vault - External Attribution Loader + api_response = api_instance.vault_attribution_loader(batch_id, file=file) pprint(api_response) except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PricingSourcesApi->get_pa_pricing_sources: %s\n" % e) + print("Exception when calling VaultAttributionLoaderApi->vault_attribution_loader: %s\n" % e) ``` @@ -71,14 +78,13 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **name** | **str**| PA pricing sources name | [optional] if omitted the server will use the default value of "" - **category** | **str**| PA pricing sources category | [optional] if omitted the server will use the default value of "" - **directory** | **str**| The directory to get the PA pricing sources in | [optional] if omitted the server will use the default value of "" + **batch_id** | **str**| | + **file** | **file_type, none_type**| | [optional] ### Return type - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**PAPricingSourceRoot**](PAPricingSourceRoot.md) + - **Response datatype**: [**VaultAttributionLoaderResponseRoot**](VaultAttributionLoaderResponseRoot.md) ### Authorization @@ -86,21 +92,20 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: multipart/form-data - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Expected response, returns a list of PA pricing sources | * X-DataDirect-Request-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 pricing sources list cached response.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Pricing sources not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**200** | Expected response, returns a status of operation along with errors and warnings if found any. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Bad Request | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/ColumnRoot.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md similarity index 60% rename from auto-generated-sdk/docs/ColumnRoot.md rename to auto-generated-sdk/docs/VaultAttributionLoaderResponse.md index 35630808..7d4e0746 100644 --- a/auto-generated-sdk/docs/ColumnRoot.md +++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md @@ -1,11 +1,12 @@ -# ColumnRoot +# VaultAttributionLoaderResponse ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**Column**](Column.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**process_id** | **str** | ProcessId. | [optional] +**group_id** | **str** | GroupId. | [optional] +**object_id** | **str** | ObjectId. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/ColumnSummaryRoot.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md similarity index 74% rename from auto-generated-sdk/docs/ColumnSummaryRoot.md rename to auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md index ccc1f118..9576a88d 100644 --- a/auto-generated-sdk/docs/ColumnSummaryRoot.md +++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md @@ -1,10 +1,10 @@ -# ColumnSummaryRoot +# VaultAttributionLoaderResponseRoot ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**{str: (ColumnSummary,)}**](ColumnSummary.md) | | +**data** | [**VaultAttributionLoaderResponse**](VaultAttributionLoaderResponse.md) | | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/VaultCalculationsApi.md b/auto-generated-sdk/docs/VaultCalculationsApi.md index 2054fea7..4737ab50 100644 --- a/auto-generated-sdk/docs/VaultCalculationsApi.md +++ b/auto-generated-sdk/docs/VaultCalculationsApi.md @@ -86,7 +86,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json, text/json + - **Accept**: application/json ### HTTP response details diff --git a/auto-generated-sdk/fds/analyticsapi/engines/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/__init__.py index b0853cb9..6ff3fa7d 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/__init__.py @@ -11,7 +11,7 @@ """ -__version__ = "6.0.0" +__version__ = "6.1.0-rc.1" # import ApiClient from fds.analyticsapi.engines.api_client import ApiClient diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py deleted file mode 100644 index 05991551..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.column_root import ColumnRoot -from fds.analyticsapi.engines.model.column_summary_root import ColumnSummaryRoot - - -class ColumnsApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __get_pa_column_by_id( - self, - id, - **kwargs - ): - """Get PA column settings # noqa: E501 - - This endpoint returns the default settings of a PA column. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_column_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for a column - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - ColumnRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_pa_column_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(ColumnRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/columns/{id}', - 'operation_id': 'get_pa_column_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_column_by_id - ) - - def __get_pa_columns( - self, - **kwargs - ): - """Get PA columns # noqa: E501 - - This endpoint lists all the PA columns that can be applied to a calculation. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_columns(async_req=True) - >>> result = thread.get() - - - Keyword Args: - name (str): Column name. [optional] if omitted the server will use the default value of "" - category (str): Column category. [optional] if omitted the server will use the default value of "" - directory (str): The directory to get the columns in. [optional] if omitted the server will use the default value of "" - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - ColumnSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_pa_columns = _Endpoint( - settings={ - 'response_type': dict({ 200:(ColumnSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/columns', - 'operation_id': 'get_pa_columns', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'name', - 'category', - 'directory', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'name': - (str,), - 'category': - (str,), - 'directory': - (str,), - }, - 'attribute_map': { - 'name': 'name', - 'category': 'category', - 'directory': 'directory', - }, - 'location_map': { - 'name': 'query', - 'category': 'query', - 'directory': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_columns - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py index 5f3c3984..88d37741 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py @@ -24,7 +24,6 @@ ) from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.component_summary_root import ComponentSummaryRoot -from fds.analyticsapi.engines.model.pa_component_root import PAComponentRoot from fds.analyticsapi.engines.model.spar_component_root import SPARComponentRoot from fds.analyticsapi.engines.model.vault_component_root import VaultComponentRoot @@ -41,246 +40,6 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def __get_pa_component_by_id( - self, - id, - **kwargs - ): - """Get PA component by id # noqa: E501 - - This endpoint returns the default settings of a PA component. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_component_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for a PA component - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - PAComponentRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_pa_component_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(PAComponentRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/components/{id}', - 'operation_id': 'get_pa_component_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_component_by_id - ) - - def __get_pa_components( - self, - document, - **kwargs - ): - """Get PA components # noqa: E501 - - This endpoint returns the list of PA components in a given PA document. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_components(document, async_req=True) - >>> result = thread.get() - - Args: - document (str): Document Name - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - ComponentSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['document'] = \ - document - return self.call_with_http_info(**kwargs) - - self.get_pa_components = _Endpoint( - settings={ - 'response_type': dict({ 200:(ComponentSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/components', - 'operation_id': 'get_pa_components', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'document', - ], - 'required': [ - 'document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'document': - (str,), - }, - 'attribute_map': { - 'document': 'document', - }, - 'location_map': { - 'document': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_components - ) - def __get_spar_component_by_id( self, id, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py index b73c6dd8..65a72e48 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py @@ -38,152 +38,6 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def __convert_pa_dates_to_absolute_format( - self, - enddate, - componentid, - account, - **kwargs - ): - """Convert PA dates to absolute format # noqa: E501 - - 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. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.convert_pa_dates_to_absolute_format(enddate, componentid, account, async_req=True) - >>> result = thread.get() - - Args: - enddate (str): End Date - componentid (str): Component Id - account (str): Account ( Account Name ending with .ACCT or .ACTM ) - - Keyword Args: - startdate (str): Start Date. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - DateParametersSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['enddate'] = \ - enddate - kwargs['componentid'] = \ - componentid - kwargs['account'] = \ - account - return self.call_with_http_info(**kwargs) - - self.convert_pa_dates_to_absolute_format = _Endpoint( - settings={ - 'response_type': dict({ 200:(DateParametersSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/dates', - 'operation_id': 'convert_pa_dates_to_absolute_format', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'enddate', - 'componentid', - 'account', - 'startdate', - ], - 'required': [ - 'enddate', - 'componentid', - 'account', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'enddate': - (str,), - 'componentid': - (str,), - 'account': - (str,), - 'startdate': - (str,), - }, - 'attribute_map': { - 'enddate': 'enddate', - 'componentid': 'componentid', - 'account': 'account', - 'startdate': 'startdate', - }, - 'location_map': { - 'enddate': 'query', - 'componentid': 'query', - 'account': 'query', - 'startdate': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__convert_pa_dates_to_absolute_format - ) - def __convert_vault_dates_to_absolute_format( self, enddate, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py index 89e90dd8..449a6d32 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py @@ -38,126 +38,6 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def __get_pa3_documents( - self, - path, - **kwargs - ): - """Get PA3 documents and sub-directories in a directory # noqa: E501 - - This endpoint looks up all PA3 documents and sub-directories in a given directory. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa3_documents(path, async_req=True) - >>> result = thread.get() - - Args: - path (str): The directory to get the documents and sub-directories in - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - DocumentDirectoriesRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['path'] = \ - path - return self.call_with_http_info(**kwargs) - - self.get_pa3_documents = _Endpoint( - settings={ - 'response_type': dict({ 200:(DocumentDirectoriesRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/documents/{path}', - 'operation_id': 'get_pa3_documents', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'path', - ], - 'required': [ - 'path', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'path': - (str,), - }, - 'attribute_map': { - 'path': 'path', - }, - 'location_map': { - 'path': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa3_documents - ) - def __get_pub_documents( self, path, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py index 542accf9..c49cefac 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py @@ -152,9 +152,7 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py deleted file mode 100644 index 1ab4b386..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py +++ /dev/null @@ -1,795 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.calculation_info_root import CalculationInfoRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot -from fds.analyticsapi.engines.model.object_root import ObjectRoot - - -class FPOOptimizerApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __cancel_optimization_by_id( - self, - id, - **kwargs - ): - """Cancel FPO optimization by id # noqa: E501 - - This is the endpoint to cancel a previously submitted optimization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.cancel_optimization_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Create and Run FPO optimization endpoint - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.cancel_optimization_by_id = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}', - 'operation_id': 'cancel_optimization_by_id', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__cancel_optimization_by_id - ) - - def __get_optimization_parameters( - self, - id, - **kwargs - ): - """Get FPO optimization parameters by id # noqa: E501 - - This is the endpoint that returns the optimization parameters passed for an optimization. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_optimization_parameters(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Create and Run FPO optimization endpoint - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - FPOOptimizationParametersRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_optimization_parameters = _Endpoint( - settings={ - 'response_type': dict({ 200:(FPOOptimizationParametersRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}', - 'operation_id': 'get_optimization_parameters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_optimization_parameters - ) - - def __get_optimization_result( - self, - id, - **kwargs - ): - """Get FPO optimization result by id # noqa: E501 - - This is the endpoint to get the result of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_optimization_result(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Get FPO optimization status by id endpoint - - Keyword Args: - accept (str): Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or *. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - ObjectRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_optimization_result = _Endpoint( - settings={ - 'response_type': dict({ 200:(ObjectRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}/result', - 'operation_id': 'get_optimization_result', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'accept', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'accept': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'accept': 'Accept', - }, - 'location_map': { - 'id': 'path', - 'accept': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_optimization_result - ) - - def __get_optimization_status_by_id( - self, - id, - **kwargs - ): - """Get FPO optimization status by id # noqa: E501 - - 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. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_optimization_status_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Create and Run FPO optimization endpoint - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - (For 201 status - ObjectRoot)(For 202 status - None) - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_optimization_status_by_id = _Endpoint( - settings={ - 'response_type': dict({ 201:(ObjectRoot,), 202:None, }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}/status', - 'operation_id': 'get_optimization_status_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_optimization_status_by_id - ) - - def __post_and_optimize( - self, - **kwargs - ): - """Create and Run FPO optimization # noqa: E501 - - This endpoint runs FPO optimization specified in the POST body parameters. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.post_and_optimize(async_req=True) - >>> result = thread.get() - - - Keyword Args: - x_fact_set_api_long_running_deadline (int): Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.. [optional] - cache_control (str): Standard HTTP header. Accepts max-stale.. [optional] - fpo_optimization_parameters_root (FPOOptimizationParametersRoot): Optimization Parameters. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.post_and_optimize = _Endpoint( - settings={ - 'response_type': dict({ 202:(CalculationInfoRoot,), 201:(ObjectRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/fpo/v3/optimizations', - 'operation_id': 'post_and_optimize', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'x_fact_set_api_long_running_deadline', - 'cache_control', - 'fpo_optimization_parameters_root', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'x_fact_set_api_long_running_deadline': - (int,), - 'cache_control': - (str,), - 'fpo_optimization_parameters_root': - (FPOOptimizationParametersRoot,), - }, - 'attribute_map': { - 'x_fact_set_api_long_running_deadline': 'X-FactSet-Api-Long-Running-Deadline', - 'cache_control': 'Cache-Control', - }, - 'location_map': { - 'x_fact_set_api_long_running_deadline': 'header', - 'cache_control': 'header', - 'fpo_optimization_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__post_and_optimize - ) - - def __put_and_optimize( - self, - id, - **kwargs - ): - """Create or Update FPO optimization and run it. # noqa: E501 - - This endpoint updates and run the FPO optimization specified in the PUT body parameters. It also allows the creation of new FPO optimization with custom id. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_and_optimize(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Create and Run FPO optimization endpoint - - Keyword Args: - x_fact_set_api_long_running_deadline (int): Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.. [optional] - cache_control (str): Standard HTTP header. Accepts max-stale.. [optional] - fpo_optimization_parameters_root (FPOOptimizationParametersRoot): Optimization Parameters. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.put_and_optimize = _Endpoint( - settings={ - 'response_type': dict({ 202:(CalculationInfoRoot,), 201:(ObjectRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}', - 'operation_id': 'put_and_optimize', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'x_fact_set_api_long_running_deadline', - 'cache_control', - 'fpo_optimization_parameters_root', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'x_fact_set_api_long_running_deadline': - (int,), - 'cache_control': - (str,), - 'fpo_optimization_parameters_root': - (FPOOptimizationParametersRoot,), - }, - 'attribute_map': { - 'id': 'id', - 'x_fact_set_api_long_running_deadline': 'X-FactSet-Api-Long-Running-Deadline', - 'cache_control': 'Cache-Control', - }, - 'location_map': { - 'id': 'path', - 'x_fact_set_api_long_running_deadline': 'header', - 'cache_control': 'header', - 'fpo_optimization_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__put_and_optimize - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py index e8047224..114cb700 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py @@ -37,114 +37,6 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def __get_pa_frequencies( - self, - **kwargs - ): - """Get PA frequencies # noqa: E501 - - This endpoint lists all the frequencies that can be applied to a PA calculation. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_frequencies(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - FrequencyRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_pa_frequencies = _Endpoint( - settings={ - 'response_type': dict({ 200:(FrequencyRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/frequencies', - 'operation_id': 'get_pa_frequencies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_frequencies - ) - def __get_spar_frequencies( self, **kwargs diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py deleted file mode 100644 index 3b201e16..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py +++ /dev/null @@ -1,255 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot -from fds.analyticsapi.engines.model.group_root import GroupRoot - - -class GroupsApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __get_pa_grouping_frequencies( - self, - **kwargs - ): - """Get PA grouping frequencies # noqa: E501 - - This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_grouping_frequencies(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - FrequencyRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_pa_grouping_frequencies = _Endpoint( - settings={ - 'response_type': dict({ 200:(FrequencyRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/grouping-frequencies', - 'operation_id': 'get_pa_grouping_frequencies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_grouping_frequencies - ) - - def __get_pa_groups( - self, - **kwargs - ): - """Get PA groups # noqa: E501 - - This endpoint lists all the PA groups that can be applied to a PA calculation. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_groups(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - GroupRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_pa_groups = _Endpoint( - settings={ - 'response_type': dict({ 200:(GroupRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/groups', - 'operation_id': 'get_pa_groups', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_groups - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py deleted file mode 100644 index a3711081..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py +++ /dev/null @@ -1,663 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.linked_pa_template_parameters_root import LinkedPATemplateParametersRoot -from fds.analyticsapi.engines.model.linked_pa_template_post_summary_root import LinkedPATemplatePostSummaryRoot -from fds.analyticsapi.engines.model.linked_pa_template_root import LinkedPATemplateRoot -from fds.analyticsapi.engines.model.linked_pa_template_summary_root import LinkedPATemplateSummaryRoot -from fds.analyticsapi.engines.model.linked_pa_template_update_parameters_root import LinkedPATemplateUpdateParametersRoot - - -class LinkedPATemplatesApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __create_linked_pa_templates( - self, - linked_pa_template_parameters_root, - **kwargs - ): - """Create a linked PA template # noqa: E501 - - This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_linked_pa_templates(linked_pa_template_parameters_root, async_req=True) - >>> result = thread.get() - - Args: - linked_pa_template_parameters_root (LinkedPATemplateParametersRoot): Request Parameters - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - LinkedPATemplatePostSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['linked_pa_template_parameters_root'] = \ - linked_pa_template_parameters_root - return self.call_with_http_info(**kwargs) - - self.create_linked_pa_templates = _Endpoint( - settings={ - 'response_type': dict({ 201:(LinkedPATemplatePostSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/linked-templates', - 'operation_id': 'create_linked_pa_templates', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'linked_pa_template_parameters_root', - ], - 'required': [ - 'linked_pa_template_parameters_root', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'linked_pa_template_parameters_root': - (LinkedPATemplateParametersRoot,), - }, - 'attribute_map': { - }, - 'location_map': { - 'linked_pa_template_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__create_linked_pa_templates - ) - - def __delete_linked_pa_templates( - self, - id, - **kwargs - ): - """Delete a linked PA template. # noqa: E501 - - This endpoint deletes an existing linked PA template. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_linked_pa_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for a linked PA template - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.delete_linked_pa_templates = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/linked-templates/{id}', - 'operation_id': 'delete_linked_pa_templates', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__delete_linked_pa_templates - ) - - def __get_linked_pa_templates( - self, - **kwargs - ): - """Get linked PA templates # noqa: E501 - - This endpoint returns the list of linked PA templates in given path. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_linked_pa_templates(async_req=True) - >>> result = thread.get() - - - Keyword Args: - directory (str): Get linked PA templates in path.. [optional] - document_directory (str): Get linked PA templates for documents in document path. [optional] - document_name (str): Get linked PA templates for documents by document name. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - LinkedPATemplateSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_linked_pa_templates = _Endpoint( - settings={ - 'response_type': dict({ 200:(LinkedPATemplateSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/linked-templates', - 'operation_id': 'get_linked_pa_templates', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'directory', - 'document_directory', - 'document_name', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'directory': - (str,), - 'document_directory': - (str,), - 'document_name': - (str,), - }, - 'attribute_map': { - 'directory': 'directory', - 'document_directory': 'documentDirectory', - 'document_name': 'documentName', - }, - 'location_map': { - 'directory': 'query', - 'document_directory': 'query', - 'document_name': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_linked_pa_templates - ) - - def __get_linked_pa_templates_by_id( - self, - id, - **kwargs - ): - """Get linked PA template by id # noqa: E501 - - This endpoint fetches the linked PA template settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_linked_pa_templates_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for a linked PA template - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - LinkedPATemplateRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_linked_pa_templates_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(LinkedPATemplateRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/linked-templates/{id}', - 'operation_id': 'get_linked_pa_templates_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_linked_pa_templates_by_id - ) - - def __update_linked_pa_templates( - self, - id, - linked_pa_template_update_parameters_root, - **kwargs - ): - """Update a linked PA template # noqa: E501 - - This endpoint allows the user to change the request body and description from an existing template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_linked_pa_templates(id, linked_pa_template_update_parameters_root, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for a linked PA template - linked_pa_template_update_parameters_root (LinkedPATemplateUpdateParametersRoot): Request Parameters - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - LinkedPATemplatePostSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - kwargs['linked_pa_template_update_parameters_root'] = \ - linked_pa_template_update_parameters_root - return self.call_with_http_info(**kwargs) - - self.update_linked_pa_templates = _Endpoint( - settings={ - 'response_type': dict({ 200:(LinkedPATemplatePostSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/linked-templates/{id}', - 'operation_id': 'update_linked_pa_templates', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'linked_pa_template_update_parameters_root', - ], - 'required': [ - 'id', - 'linked_pa_template_update_parameters_root', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'linked_pa_template_update_parameters_root': - (LinkedPATemplateUpdateParametersRoot,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - 'linked_pa_template_update_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__update_linked_pa_templates - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py deleted file mode 100644 index 44812edb..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py +++ /dev/null @@ -1,917 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.calculation_status_root import CalculationStatusRoot -from fds.analyticsapi.engines.model.calculations_summary_root import CalculationsSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.object_root import ObjectRoot -from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot - - -class PACalculationsApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __cancel_calculation_by_id( - self, - id, - **kwargs - ): - """Cancel PA calculation by id # noqa: E501 - - This is the endpoint to cancel a previously submitted calculation. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.cancel_calculation_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Create and Run PA calculation endpoint - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.cancel_calculation_by_id = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}', - 'operation_id': 'cancel_calculation_by_id', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__cancel_calculation_by_id - ) - - def __get_all_calculations( - self, - **kwargs - ): - """Get all calculations # noqa: E501 - - This endpoints returns all calculation requests. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_calculations(async_req=True) - >>> result = thread.get() - - - Keyword Args: - page_number (int): [optional] if omitted the server will use the default value of 1 - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - CalculationsSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_all_calculations = _Endpoint( - settings={ - 'response_type': dict({ 200:(CalculationsSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations', - 'operation_id': 'get_all_calculations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'page_number', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'page_number': - (int,), - }, - 'attribute_map': { - 'page_number': 'pageNumber', - }, - 'location_map': { - 'page_number': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_all_calculations - ) - - def __get_calculation_parameters( - self, - id, - **kwargs - ): - """Get PA calculation parameters by id # noqa: E501 - - This is the endpoint that returns the calculation parameters passed for a calculation. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_calculation_parameters(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Create and Run PA calculation endpoint - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - PACalculationParametersRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_calculation_parameters = _Endpoint( - settings={ - 'response_type': dict({ 200:(PACalculationParametersRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}', - 'operation_id': 'get_calculation_parameters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_calculation_parameters - ) - - def __get_calculation_status_by_id( - self, - id, - **kwargs - ): - """Get PA calculation status by id # noqa: E501 - - This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the location header will point to the result url. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_calculation_status_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Create and Run PA calculation endpoint - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - CalculationStatusRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_calculation_status_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(CalculationStatusRoot,), 202:(CalculationStatusRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/status', - 'operation_id': 'get_calculation_status_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_calculation_status_by_id - ) - - def __get_calculation_unit_result_by_id( - self, - id, - unit_id, - **kwargs - ): - """Get PA calculation result by id # noqa: E501 - - This is the endpoint to get the result of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_calculation_unit_result_by_id(id, unit_id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Get PA calculation status by id endpoint - unit_id (str): from url, provided from the location header in the Get PA calculation status by id endpoint - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - ObjectRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - kwargs['unit_id'] = \ - unit_id - return self.call_with_http_info(**kwargs) - - self.get_calculation_unit_result_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(ObjectRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result', - 'operation_id': 'get_calculation_unit_result_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'unit_id', - ], - 'required': [ - 'id', - 'unit_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'unit_id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'unit_id': 'unitId', - }, - 'location_map': { - 'id': 'path', - 'unit_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/x-protobuf' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_calculation_unit_result_by_id - ) - - def __post_and_calculate( - self, - **kwargs - ): - """Create and Run PA calculation # noqa: E501 - - This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.post_and_calculate(async_req=True) - >>> result = thread.get() - - - Keyword Args: - x_fact_set_api_long_running_deadline (int): Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.. [optional] - cache_control (str): Standard HTTP header. Accepts max-stale.. [optional] - pa_calculation_parameters_root (PACalculationParametersRoot): Calculation Parameters. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - (For 202 status - CalculationStatusRoot)(For 201 status - ObjectRoot)(For 200 status - CalculationStatusRoot) - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.post_and_calculate = _Endpoint( - settings={ - 'response_type': dict({ 202:(CalculationStatusRoot,), 201:(ObjectRoot,), 200:(CalculationStatusRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations', - 'operation_id': 'post_and_calculate', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'x_fact_set_api_long_running_deadline', - 'cache_control', - 'pa_calculation_parameters_root', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'x_fact_set_api_long_running_deadline': - (int,), - 'cache_control': - (str,), - 'pa_calculation_parameters_root': - (PACalculationParametersRoot,), - }, - 'attribute_map': { - 'x_fact_set_api_long_running_deadline': 'X-FactSet-Api-Long-Running-Deadline', - 'cache_control': 'Cache-Control', - }, - 'location_map': { - 'x_fact_set_api_long_running_deadline': 'header', - 'cache_control': 'header', - 'pa_calculation_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/x-protobuf' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__post_and_calculate - ) - - def __put_and_calculate( - self, - id, - **kwargs - ): - """Create or Update PA calculation and run it. # noqa: E501 - - This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.put_and_calculate(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): from url, provided from the location header in the Create and Run PA calculation endpoint - - Keyword Args: - x_fact_set_api_long_running_deadline (int): Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. [optional] - cache_control (str): Standard HTTP header. Accepts max-stale.. [optional] - pa_calculation_parameters_root (PACalculationParametersRoot): Calculation Parameters. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - ObjectRoot) - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.put_and_calculate = _Endpoint( - settings={ - 'response_type': dict({ 202:(CalculationStatusRoot,), 200:(CalculationStatusRoot,), 201:(ObjectRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}', - 'operation_id': 'put_and_calculate', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'x_fact_set_api_long_running_deadline', - 'cache_control', - 'pa_calculation_parameters_root', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'x_fact_set_api_long_running_deadline': - (int,), - 'cache_control': - (str,), - 'pa_calculation_parameters_root': - (PACalculationParametersRoot,), - }, - 'attribute_map': { - 'id': 'id', - 'x_fact_set_api_long_running_deadline': 'X-FactSet-Api-Long-Running-Deadline', - 'cache_control': 'Cache-Control', - }, - 'location_map': { - 'id': 'path', - 'x_fact_set_api_long_running_deadline': 'header', - 'cache_control': 'header', - 'pa_calculation_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/x-protobuf' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__put_and_calculate - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py deleted file mode 100644 index 45213727..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py +++ /dev/null @@ -1,165 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.pa_pricing_source_root import PAPricingSourceRoot - - -class PricingSourcesApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __get_pa_pricing_sources( - self, - **kwargs - ): - """Get PA pricing sources # noqa: E501 - - This endpoint lists all the PA pricing sources that can be applied to a PA calculation. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_pricing_sources(async_req=True) - >>> result = thread.get() - - - Keyword Args: - name (str): PA pricing sources name. [optional] if omitted the server will use the default value of "" - category (str): PA pricing sources category. [optional] if omitted the server will use the default value of "" - directory (str): The directory to get the PA pricing sources in. [optional] if omitted the server will use the default value of "" - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - PAPricingSourceRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_pa_pricing_sources = _Endpoint( - settings={ - 'response_type': dict({ 200:(PAPricingSourceRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/pricing-sources', - 'operation_id': 'get_pa_pricing_sources', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'name', - 'category', - 'directory', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'name': - (str,), - 'category': - (str,), - 'directory': - (str,), - }, - 'attribute_map': { - 'name': 'name', - 'category': 'category', - 'directory': 'directory', - }, - 'location_map': { - 'name': 'query', - 'category': 'query', - 'directory': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_pricing_sources - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py index daa6591a..901503a3 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py @@ -152,9 +152,7 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, @@ -638,9 +636,9 @@ def __get_calculation_unit_result_by_id( }, headers_map={ 'accept': [ - 'application/json', - 'application/x-protobuf', - 'application/pdf' + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.presentationml.presentation', + 'application/json' ], 'content_type': [], }, @@ -687,7 +685,7 @@ def __post_and_calculate( async_req (bool): execute request asynchronously Returns: - (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) + (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) If the method is called asynchronously, returns the request thread. """ @@ -714,7 +712,7 @@ def __post_and_calculate( self.post_and_calculate = _Endpoint( settings={ - 'response_type': dict({ 202:(CalculationStatusRoot,), 200:(CalculationStatusRoot,), 201:(file_type,), }), + 'response_type': dict({ 200:(CalculationStatusRoot,), 201:(file_type,), 202:(CalculationStatusRoot,), }), 'auth': [ 'Basic', 'Bearer' @@ -765,6 +763,7 @@ def __post_and_calculate( }, headers_map={ 'accept': [ + 'application/json', 'application/pdf', 'application/vnd.openxmlformats-officedocument.presentationml.presentation' ], @@ -818,7 +817,7 @@ def __put_and_calculate( async_req (bool): execute request asynchronously Returns: - (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) + (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) If the method is called asynchronously, returns the request thread. """ @@ -847,7 +846,7 @@ def __put_and_calculate( self.put_and_calculate = _Endpoint( settings={ - 'response_type': dict({ 202:(CalculationStatusRoot,), 200:(CalculationStatusRoot,), 201:(file_type,), }), + 'response_type': dict({ 200:(CalculationStatusRoot,), 201:(file_type,), 202:(CalculationStatusRoot,), }), 'auth': [ 'Basic', 'Bearer' @@ -905,7 +904,9 @@ def __put_and_calculate( }, headers_map={ 'accept': [ - 'application/pdf' + 'application/json', + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.presentationml.presentation' ], 'content_type': [ 'application/json' diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py index 0cbd1688..8c5173e7 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py @@ -153,9 +153,7 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py index 779c8477..bc337c87 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py @@ -153,9 +153,7 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py index 4934bd50..715f5c10 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py @@ -398,126 +398,6 @@ def __get_barra_strategy_documents( callable=__get_barra_strategy_documents ) - def __get_fpo_strategy_documents( - self, - path, - **kwargs - ): - """Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory # noqa: E501 - - This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_fpo_strategy_documents(path, async_req=True) - >>> result = thread.get() - - Args: - path (str): The directory to get the strategy documents and sub-directories in - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - DocumentDirectoriesRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['path'] = \ - path - return self.call_with_http_info(**kwargs) - - self.get_fpo_strategy_documents = _Endpoint( - settings={ - 'response_type': dict({ 200:(DocumentDirectoriesRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/fpo/v3/strategies/{path}', - 'operation_id': 'get_fpo_strategy_documents', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'path', - ], - 'required': [ - 'path', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'path': - (str,), - }, - 'attribute_map': { - 'path': 'path', - }, - 'location_map': { - 'path': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_fpo_strategy_documents - ) - def __get_northfield_strategy_documents( self, path, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py deleted file mode 100644 index 29853f02..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py +++ /dev/null @@ -1,659 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.templated_pa_component_parameters_root import TemplatedPAComponentParametersRoot -from fds.analyticsapi.engines.model.templated_pa_component_post_summary_root import TemplatedPAComponentPostSummaryRoot -from fds.analyticsapi.engines.model.templated_pa_component_root import TemplatedPAComponentRoot -from fds.analyticsapi.engines.model.templated_pa_component_summary_root import TemplatedPAComponentSummaryRoot -from fds.analyticsapi.engines.model.templated_pa_component_update_parameters_root import TemplatedPAComponentUpdateParametersRoot - - -class TemplatedPAComponentsApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __create_templated_pa_components( - self, - templated_pa_component_parameters_root, - **kwargs - ): - """Create templated PA component # noqa: E501 - - This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_templated_pa_components(templated_pa_component_parameters_root, async_req=True) - >>> result = thread.get() - - Args: - templated_pa_component_parameters_root (TemplatedPAComponentParametersRoot): Request Parameters - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - TemplatedPAComponentPostSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['templated_pa_component_parameters_root'] = \ - templated_pa_component_parameters_root - return self.call_with_http_info(**kwargs) - - self.create_templated_pa_components = _Endpoint( - settings={ - 'response_type': dict({ 201:(TemplatedPAComponentPostSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/templated-components', - 'operation_id': 'create_templated_pa_components', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'templated_pa_component_parameters_root', - ], - 'required': [ - 'templated_pa_component_parameters_root', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'templated_pa_component_parameters_root': - (TemplatedPAComponentParametersRoot,), - }, - 'attribute_map': { - }, - 'location_map': { - 'templated_pa_component_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__create_templated_pa_components - ) - - def __delete_templated_pa_components( - self, - id, - **kwargs - ): - """Delete templated PA component # noqa: E501 - - This endpoint deletes an existing templated PA component # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_templated_pa_components(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for a templated PA component - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.delete_templated_pa_components = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/templated-components/{id}', - 'operation_id': 'delete_templated_pa_components', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'text/plain', - 'application/json', - 'text/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__delete_templated_pa_components - ) - - def __get_templated_pa_component_by_id( - self, - id, - **kwargs - ): - """Get templated PA component by id # noqa: E501 - - This endpoint fetches the templated PA component settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_templated_pa_component_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for a templated PA component - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - TemplatedPAComponentRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_templated_pa_component_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(TemplatedPAComponentRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/templated-components/{id}', - 'operation_id': 'get_templated_pa_component_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_templated_pa_component_by_id - ) - - def __get_templated_pa_components_in_path( - self, - directory, - **kwargs - ): - """Get templated PA components in path # noqa: E501 - - This endpoint returns the list of templated PA components in path. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_templated_pa_components_in_path(directory, async_req=True) - >>> result = thread.get() - - Args: - directory (str): Get templated PA components in path - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - TemplatedPAComponentSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['directory'] = \ - directory - return self.call_with_http_info(**kwargs) - - self.get_templated_pa_components_in_path = _Endpoint( - settings={ - 'response_type': dict({ 200:(TemplatedPAComponentSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/templated-components', - 'operation_id': 'get_templated_pa_components_in_path', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'directory', - ], - 'required': [ - 'directory', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'directory': - (str,), - }, - 'attribute_map': { - 'directory': 'directory', - }, - 'location_map': { - 'directory': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_templated_pa_components_in_path - ) - - def __update_templated_pa_components( - self, - id, - templated_pa_component_update_parameters_root, - **kwargs - ): - """Update templated PA component # noqa: E501 - - This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_templated_pa_components(id, templated_pa_component_update_parameters_root, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for a templated PA component - templated_pa_component_update_parameters_root (TemplatedPAComponentUpdateParametersRoot): Request Parameters - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - TemplatedPAComponentPostSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - kwargs['templated_pa_component_update_parameters_root'] = \ - templated_pa_component_update_parameters_root - return self.call_with_http_info(**kwargs) - - self.update_templated_pa_components = _Endpoint( - settings={ - 'response_type': dict({ 200:(TemplatedPAComponentPostSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/templated-components/{id}', - 'operation_id': 'update_templated_pa_components', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'templated_pa_component_update_parameters_root', - ], - 'required': [ - 'id', - 'templated_pa_component_update_parameters_root', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'templated_pa_component_update_parameters_root': - (TemplatedPAComponentUpdateParametersRoot,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - 'templated_pa_component_update_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__update_templated_pa_components - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py deleted file mode 100644 index 4acbe929..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py +++ /dev/null @@ -1,885 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details_root import UnlinkedPATemplateCategoryAndTypeDetailsRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_root import UnlinkedPATemplateCategoryAndTypeRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_parameters_root import UnlinkedPATemplateParametersRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary_root import UnlinkedPATemplatePostSummaryRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_root import UnlinkedPATemplateRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_summary_root import UnlinkedPATemplateSummaryRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters_root import UnlinkedPATemplateUpdateParametersRoot - - -class UnlinkedPATemplatesApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __create_unlinked_pa_templates( - self, - unlinked_pa_template_parameters_root, - **kwargs - ): - """Create unlinked PA template # noqa: E501 - - This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_unlinked_pa_templates(unlinked_pa_template_parameters_root, async_req=True) - >>> result = thread.get() - - Args: - unlinked_pa_template_parameters_root (UnlinkedPATemplateParametersRoot): Request Parameters - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - UnlinkedPATemplatePostSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['unlinked_pa_template_parameters_root'] = \ - unlinked_pa_template_parameters_root - return self.call_with_http_info(**kwargs) - - self.create_unlinked_pa_templates = _Endpoint( - settings={ - 'response_type': dict({ 201:(UnlinkedPATemplatePostSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates', - 'operation_id': 'create_unlinked_pa_templates', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'unlinked_pa_template_parameters_root', - ], - 'required': [ - 'unlinked_pa_template_parameters_root', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'unlinked_pa_template_parameters_root': - (UnlinkedPATemplateParametersRoot,), - }, - 'attribute_map': { - }, - 'location_map': { - 'unlinked_pa_template_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__create_unlinked_pa_templates - ) - - def __delete_unlinked_pa_templates( - self, - id, - **kwargs - ): - """Delete unlinked PA template # noqa: E501 - - This endpoint deletes an existing unliked PA template. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_unlinked_pa_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for an unlinked PA template - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.delete_unlinked_pa_templates = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/{id}', - 'operation_id': 'delete_unlinked_pa_templates', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__delete_unlinked_pa_templates - ) - - def __get_default_unlinked_pa_template_types( - self, - **kwargs - ): - """Get default unlinked PA template types. # noqa: E501 - - This endpoint fetches default unlinked PA template types. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_default_unlinked_pa_template_types(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - UnlinkedPATemplateCategoryAndTypeRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_default_unlinked_pa_template_types = _Endpoint( - settings={ - 'response_type': dict({ 200:(UnlinkedPATemplateCategoryAndTypeRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/template-types', - 'operation_id': 'get_default_unlinked_pa_template_types', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_default_unlinked_pa_template_types - ) - - def __get_details_type( - self, - id, - **kwargs - ): - """Get unlinked PA template type details by id. # noqa: E501 - - This endpoint fetches the unlinked PA template type details. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_details_type(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for an unlinked PA template type - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - UnlinkedPATemplateCategoryAndTypeDetailsRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_details_type = _Endpoint( - settings={ - 'response_type': dict({ 200:(UnlinkedPATemplateCategoryAndTypeDetailsRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/template-types/{id}', - 'operation_id': 'get_details_type', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_details_type - ) - - def __get_unlinked_pa_templates( - self, - **kwargs - ): - """Get unlinked PA templates # noqa: E501 - - This endpoint returns the list of unlinked PA templates. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_unlinked_pa_templates(async_req=True) - >>> result = thread.get() - - - Keyword Args: - directory (str): Get unlinked PA templates in path.. [optional] - category (str): Get unlinked PA templates by category.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - UnlinkedPATemplateSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.call_with_http_info(**kwargs) - - self.get_unlinked_pa_templates = _Endpoint( - settings={ - 'response_type': dict({ 200:(UnlinkedPATemplateSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates', - 'operation_id': 'get_unlinked_pa_templates', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'directory', - 'category', - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'directory': - (str,), - 'category': - (str,), - }, - 'attribute_map': { - 'directory': 'directory', - 'category': 'category', - }, - 'location_map': { - 'directory': 'query', - 'category': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_unlinked_pa_templates - ) - - def __get_unlinked_pa_templates_by_id( - self, - id, - **kwargs - ): - """Get unlinked PA template details by id # noqa: E501 - - This endpoint fetches the template settings. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_unlinked_pa_templates_by_id(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for an unlinked PA template - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - UnlinkedPATemplateRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - return self.call_with_http_info(**kwargs) - - self.get_unlinked_pa_templates_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(UnlinkedPATemplateRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/{id}', - 'operation_id': 'get_unlinked_pa_templates_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_unlinked_pa_templates_by_id - ) - - def __update_unlinked_pa_templates( - self, - id, - unlinked_pa_template_update_parameters_root, - **kwargs - ): - """Update unlinked PA template # noqa: E501 - - This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_unlinked_pa_templates(id, unlinked_pa_template_update_parameters_root, async_req=True) - >>> result = thread.get() - - Args: - id (str): Unique identifier for an unlinked PA template - unlinked_pa_template_update_parameters_root (UnlinkedPATemplateUpdateParametersRoot): Request Parameters - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - UnlinkedPATemplatePostSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - kwargs['unlinked_pa_template_update_parameters_root'] = \ - unlinked_pa_template_update_parameters_root - return self.call_with_http_info(**kwargs) - - self.update_unlinked_pa_templates = _Endpoint( - settings={ - 'response_type': dict({ 200:(UnlinkedPATemplatePostSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/{id}', - 'operation_id': 'update_unlinked_pa_templates', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'unlinked_pa_template_update_parameters_root', - ], - 'required': [ - 'id', - 'unlinked_pa_template_update_parameters_root', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'unlinked_pa_template_update_parameters_root': - (UnlinkedPATemplateUpdateParametersRoot,), - }, - 'attribute_map': { - 'id': 'id', - }, - 'location_map': { - 'id': 'path', - 'unlinked_pa_template_update_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__update_unlinked_pa_templates - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_attribution_loader_api.py similarity index 71% rename from auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py rename to auto-generated-sdk/fds/analyticsapi/engines/api/vault_attribution_loader_api.py index e5721526..6b695e79 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_attribution_loader_api.py @@ -22,10 +22,11 @@ none_type, validate_and_convert_types ) -from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.vault_attribution_loader_response_root import VaultAttributionLoaderResponseRoot -class ColumnStatisticsApi(object): +class VaultAttributionLoaderApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -37,21 +38,25 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def __get_pa_column_statistics( + def __vault_attribution_loader( self, + batch_id, **kwargs ): - """Get PA column statistics # noqa: E501 + """Vault - External Attribution Loader # noqa: E501 - This endpoint lists all the column statistics that can be applied to a PA column. # noqa: E501 + This endpoint loads Vault External Attributions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_pa_column_statistics(async_req=True) + >>> thread = api.vault_attribution_loader(batch_id, async_req=True) >>> result = thread.get() + Args: + batch_id (str): Keyword Args: + file (file_type, none_type): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is False. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -73,7 +78,7 @@ def __get_pa_column_statistics( async_req (bool): execute request asynchronously Returns: - ColumnStatisticRoot + VaultAttributionLoaderResponseRoot If the method is called asynchronously, returns the request thread. """ @@ -96,25 +101,32 @@ def __get_pa_column_statistics( '_check_return_type', True ) kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['batch_id'] = \ + batch_id return self.call_with_http_info(**kwargs) - self.get_pa_column_statistics = _Endpoint( + self.vault_attribution_loader = _Endpoint( settings={ - 'response_type': dict({ 200:(ColumnStatisticRoot,), }), + 'response_type': dict({ 200:(VaultAttributionLoaderResponseRoot,), }), 'auth': [ 'Basic', 'Bearer' ], - 'endpoint_path': '/analytics/engines/pa/v3/columnstatistics', - 'operation_id': 'get_pa_column_statistics', - 'http_method': 'GET', + 'endpoint_path': '/analytics/engines/vault/v3/load/{batchId}', + 'operation_id': 'vault_attribution_loader', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ + 'batch_id', + 'file', + ], + 'required': [ + 'batch_id', ], - 'required': [], 'nullable': [ + 'file', ], 'enum': [ ], @@ -127,10 +139,18 @@ def __get_pa_column_statistics( 'allowed_values': { }, 'openapi_types': { + 'batch_id': + (str,), + 'file': + (file_type, none_type,), }, 'attribute_map': { + 'batch_id': 'batchId', + 'file': 'file', }, 'location_map': { + 'batch_id': 'path', + 'file': 'form', }, 'collection_format_map': { } @@ -139,8 +159,10 @@ def __get_pa_column_statistics( 'accept': [ 'application/json' ], - 'content_type': [], + 'content_type': [ + 'multipart/form-data' + ] }, api_client=api_client, - callable=__get_pa_column_statistics + callable=__vault_attribution_loader ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py index 25863675..13930c14 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py @@ -153,9 +153,7 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'text/plain', - 'application/json', - 'text/json' + 'application/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api_client.py b/auto-generated-sdk/fds/analyticsapi/engines/api_client.py index 48143615..fb7dfe23 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api_client.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api_client.py @@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'engines-api/6.0.0/python' + self.user_agent = 'engines-api/6.1.0-rc.1/python' def __enter__(self): return self diff --git a/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py index fb697d8b..a8badc47 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py @@ -19,8 +19,6 @@ from fds.analyticsapi.engines.api.accounts_api import AccountsApi from fds.analyticsapi.engines.api.bpm_optimizer_api import BPMOptimizerApi from fds.analyticsapi.engines.api.benchmarks_api import BenchmarksApi -from fds.analyticsapi.engines.api.column_statistics_api import ColumnStatisticsApi -from fds.analyticsapi.engines.api.columns_api import ColumnsApi from fds.analyticsapi.engines.api.components_api import ComponentsApi from fds.analyticsapi.engines.api.configurations_api import ConfigurationsApi from fds.analyticsapi.engines.api.currencies_api import CurrenciesApi @@ -29,17 +27,11 @@ from fds.analyticsapi.engines.api.documents_api import DocumentsApi from fds.analyticsapi.engines.api.fiab_calculations_api import FIABCalculationsApi from fds.analyticsapi.engines.api.fi_calculations_api import FICalculationsApi -from fds.analyticsapi.engines.api.fpo_optimizer_api import FPOOptimizerApi from fds.analyticsapi.engines.api.frequencies_api import FrequenciesApi -from fds.analyticsapi.engines.api.groups_api import GroupsApi -from fds.analyticsapi.engines.api.linked_pa_templates_api import LinkedPATemplatesApi from fds.analyticsapi.engines.api.npo_optimizer_api import NPOOptimizerApi -from fds.analyticsapi.engines.api.pa_calculations_api import PACalculationsApi -from fds.analyticsapi.engines.api.pricing_sources_api import PricingSourcesApi from fds.analyticsapi.engines.api.pub_calculations_api import PubCalculationsApi from fds.analyticsapi.engines.api.quant_calculations_api import QuantCalculationsApi from fds.analyticsapi.engines.api.spar_calculations_api import SPARCalculationsApi from fds.analyticsapi.engines.api.strategy_documents_api import StrategyDocumentsApi -from fds.analyticsapi.engines.api.templated_pa_components_api import TemplatedPAComponentsApi -from fds.analyticsapi.engines.api.unlinked_pa_templates_api import UnlinkedPATemplatesApi from fds.analyticsapi.engines.api.vault_calculations_api import VaultCalculationsApi +from fds.analyticsapi.engines.api.vault_attribution_loader_api import VaultAttributionLoaderApi diff --git a/auto-generated-sdk/fds/analyticsapi/engines/configuration.py b/auto-generated-sdk/fds/analyticsapi/engines/configuration.py index 51d8ed2c..b9a17e02 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/configuration.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/configuration.py @@ -409,7 +409,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]\n"\ - "SDK Package Version: 6.0.0".\ + "SDK Package Version: 6.1.0-rc.1".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_status_meta.py b/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_status_meta.py index d4eae03b..27f400f0 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_status_meta.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_status_meta.py @@ -136,7 +136,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - units ({str: (CalculationUnitStatusMeta,)}): Meta of calculation units in batch.. [optional] # noqa: E501 + units ({str: (CalculationUnitStatusMeta,)}): List of calculation units in batch.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_root.py deleted file mode 100644 index b427916a..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/column_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.column import Column - globals()['Column'] = Column - - -class ColumnRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (Column,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """ColumnRoot - a model defined in OpenAPI - - Args: - data (Column): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic.py deleted file mode 100644 index 81f93b18..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic.py +++ /dev/null @@ -1,167 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class ColumnStatistic(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ColumnStatistic - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Column Statistic Name. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic_root.py deleted file mode 100644 index 95bf7b33..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.column_statistic import ColumnStatistic - globals()['ColumnStatistic'] = ColumnStatistic - - -class ColumnStatisticRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (ColumnStatistic,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """ColumnStatisticRoot - a model defined in OpenAPI - - Args: - data ({str: (ColumnStatistic,)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary.py deleted file mode 100644 index bdba6fd7..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class ColumnSummary(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'directory': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'directory': 'directory', # noqa: E501 - 'category': 'category', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ColumnSummary - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Column Name. [optional] # noqa: E501 - directory (str): Column Directory. [optional] # noqa: E501 - category (str): Column Category. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary_root.py deleted file mode 100644 index 3a1a7998..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.column_summary import ColumnSummary - globals()['ColumnSummary'] = ColumnSummary - - -class ColumnSummaryRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (ColumnSummary,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """ColumnSummaryRoot - a model defined in OpenAPI - - Args: - data ({str: (ColumnSummary,)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fi_convertible_settings.py similarity index 79% rename from auto-generated-sdk/fds/analyticsapi/engines/model/column.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/fi_convertible_settings.py index 473e4343..9b2bf8b9 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/column.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fi_convertible_settings.py @@ -28,7 +28,7 @@ ) -class Column(ModelNormal): +class FIConvertibleSettings(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -53,6 +53,11 @@ class Column(ModelNormal): """ allowed_values = { + ('volatility_cap_method',): { + 'NOCAP': "noCap", + 'SPECIFIEDRATE': "specifiedRate", + 'MULTIPLIER': "multiplier", + }, } validations = { @@ -73,10 +78,12 @@ def openapi_types(): and the value is attribute type. """ return { - 'defaultstatisticsids': ([str],), # noqa: E501 - 'name': (str,), # noqa: E501 - 'directory': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 + 'equity_price': (float,), # noqa: E501 + 'equity_index_volatility': (float,), # noqa: E501 + 'equity_dividend_yield': (float,), # noqa: E501 + 'volatility_cap_method': (str,), # noqa: E501 + 'volatility_cap_method_value': (float,), # noqa: E501 + 'equity_exchange_rate': (float,), # noqa: E501 } @cached_property @@ -85,10 +92,12 @@ def discriminator(): attribute_map = { - 'defaultstatisticsids': 'defaultstatisticsids', # noqa: E501 - 'name': 'name', # noqa: E501 - 'directory': 'directory', # noqa: E501 - 'category': 'category', # noqa: E501 + 'equity_price': 'equityPrice', # noqa: E501 + 'equity_index_volatility': 'equityIndexVolatility', # noqa: E501 + 'equity_dividend_yield': 'equityDividendYield', # noqa: E501 + 'volatility_cap_method': 'volatilityCapMethod', # noqa: E501 + 'volatility_cap_method_value': 'volatilityCapMethodValue', # noqa: E501 + 'equity_exchange_rate': 'equityExchangeRate', # noqa: E501 } _composed_schemas = {} @@ -104,7 +113,7 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """Column - a model defined in OpenAPI + """FIConvertibleSettings - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -137,10 +146,12 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - defaultstatisticsids ([str]): Column statistic Id. [optional] # noqa: E501 - name (str): Column Name. [optional] # noqa: E501 - directory (str): Column Directory. [optional] # noqa: E501 - category (str): Column Category. [optional] # noqa: E501 + equity_price (float): Equity Price. [optional] # noqa: E501 + equity_index_volatility (float): Equity Index Volatility. [optional] # noqa: E501 + equity_dividend_yield (float): Equity Dividend Yield. [optional] # noqa: E501 + volatility_cap_method (str): Volatility CapMethod. [optional] # noqa: E501 + volatility_cap_method_value (float): Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier). [optional] # noqa: E501 + equity_exchange_rate (float): Equity Exchange Rate. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fi_security.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fi_security.py index 6a5d29a4..c43cac3e 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fi_security.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fi_security.py @@ -30,6 +30,7 @@ def lazy_import(): from fds.analyticsapi.engines.model.fi_attribution_for_securities import FIAttributionForSecurities from fds.analyticsapi.engines.model.fi_bank_loans import FIBankLoans + from fds.analyticsapi.engines.model.fi_convertible_settings import FIConvertibleSettings from fds.analyticsapi.engines.model.fi_loss import FILoss from fds.analyticsapi.engines.model.fi_municipal_bonds import FIMunicipalBonds from fds.analyticsapi.engines.model.fi_prepay import FIPrepay @@ -37,6 +38,7 @@ def lazy_import(): from fds.analyticsapi.engines.model.fi_structured_products_for_securities import FIStructuredProductsForSecurities globals()['FIAttributionForSecurities'] = FIAttributionForSecurities globals()['FIBankLoans'] = FIBankLoans + globals()['FIConvertibleSettings'] = FIConvertibleSettings globals()['FILoss'] = FILoss globals()['FIMunicipalBonds'] = FIMunicipalBonds globals()['FIPrepay'] = FIPrepay @@ -113,6 +115,7 @@ def openapi_types(): 'matrix_multiplier': (float,), # noqa: E501 'structured_products': (FIStructuredProductsForSecurities,), # noqa: E501 'attribution': (FIAttributionForSecurities,), # noqa: E501 + 'convertible': (FIConvertibleSettings,), # noqa: E501 'calc_from_method': (str,), # noqa: E501 'face': (float,), # noqa: E501 'face_type': (str,), # noqa: E501 @@ -138,6 +141,7 @@ def discriminator(): 'matrix_multiplier': 'matrixMultiplier', # noqa: E501 'structured_products': 'structuredProducts', # noqa: E501 'attribution': 'attribution', # noqa: E501 + 'convertible': 'convertible', # noqa: E501 'calc_from_method': 'calcFromMethod', # noqa: E501 'face': 'face', # noqa: E501 'face_type': 'faceType', # noqa: E501 @@ -205,6 +209,7 @@ def __init__(self, calc_from_value, symbol, *args, **kwargs): # noqa: E501 matrix_multiplier (float): Matrix Multiplier. [optional] # noqa: E501 structured_products (FIStructuredProductsForSecurities): [optional] # noqa: E501 attribution (FIAttributionForSecurities): [optional] # noqa: E501 + convertible (FIConvertibleSettings): [optional] # noqa: E501 calc_from_method (str): Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix. [optional] # noqa: E501 face (float): Face. [optional] if omitted the server will use the default value of 1 # noqa: E501 face_type (str): Face type. [optional] if omitted the server will use the default value of "Current" # noqa: E501 diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_account.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_account.py deleted file mode 100644 index 64ff897d..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_account.py +++ /dev/null @@ -1,183 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.optimizer_account_overrides import OptimizerAccountOverrides - from fds.analyticsapi.engines.model.pa_doc import PaDoc - globals()['OptimizerAccountOverrides'] = OptimizerAccountOverrides - globals()['PaDoc'] = PaDoc - - -class FPOAccount(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'pa_document': (PaDoc,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'overrides': (OptimizerAccountOverrides,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'pa_document': 'paDocument', # noqa: E501 - 'id': 'id', # noqa: E501 - 'overrides': 'overrides', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, pa_document, *args, **kwargs): # noqa: E501 - """FPOAccount - a model defined in OpenAPI - - Args: - pa_document (PaDoc): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): Account path. [optional] # noqa: E501 - overrides (OptimizerAccountOverrides): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.pa_document = pa_document - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_objective.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_objective.py deleted file mode 100644 index 30063224..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_objective.py +++ /dev/null @@ -1,174 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class FPOObjective(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('terms',): { - 'DISABLE': "Disable", - 'ENABLE': "Enable", - }, - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'active': (str,), # noqa: E501 - 'terms': ({str: (str,)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'active': 'active', # noqa: E501 - 'terms': 'terms', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """FPOObjective - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - active (str): [optional] # noqa: E501 - terms ({str: (str,)}): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters.py deleted file mode 100644 index 110fd894..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters.py +++ /dev/null @@ -1,191 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.fpo_account import FPOAccount - from fds.analyticsapi.engines.model.fpo_optimizer_strategy import FPOOptimizerStrategy - from fds.analyticsapi.engines.model.optimization import Optimization - from fds.analyticsapi.engines.model.optimizer_output_types import OptimizerOutputTypes - globals()['FPOAccount'] = FPOAccount - globals()['FPOOptimizerStrategy'] = FPOOptimizerStrategy - globals()['Optimization'] = Optimization - globals()['OptimizerOutputTypes'] = OptimizerOutputTypes - - -class FPOOptimizationParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'strategy': (FPOOptimizerStrategy,), # noqa: E501 - 'output_types': (OptimizerOutputTypes,), # noqa: E501 - 'account': (FPOAccount,), # noqa: E501 - 'optimization': (Optimization,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'strategy': 'strategy', # noqa: E501 - 'output_types': 'outputTypes', # noqa: E501 - 'account': 'account', # noqa: E501 - 'optimization': 'optimization', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, strategy, output_types, *args, **kwargs): # noqa: E501 - """FPOOptimizationParameters - a model defined in OpenAPI - - Args: - strategy (FPOOptimizerStrategy): - output_types (OptimizerOutputTypes): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - account (FPOAccount): [optional] # noqa: E501 - optimization (Optimization): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.strategy = strategy - self.output_types = output_types - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py deleted file mode 100644 index 2bbe8205..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py +++ /dev/null @@ -1,175 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.fpo_optimization_parameters import FPOOptimizationParameters - globals()['FPOOptimizationParameters'] = FPOOptimizationParameters - - -class FPOOptimizationParametersRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (FPOOptimizationParameters,), # noqa: E501 - 'meta': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """FPOOptimizationParametersRoot - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data (FPOOptimizationParameters): [optional] # noqa: E501 - meta ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy.py deleted file mode 100644 index 8990305b..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.fpo_optimizer_strategy_overrides import FPOOptimizerStrategyOverrides - globals()['FPOOptimizerStrategyOverrides'] = FPOOptimizerStrategyOverrides - - -class FPOOptimizerStrategy(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'overrides': (FPOOptimizerStrategyOverrides,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'overrides': 'overrides', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """FPOOptimizerStrategy - a model defined in OpenAPI - - Args: - id (str): OptimizerStrategy document path - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - overrides (FPOOptimizerStrategyOverrides): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py deleted file mode 100644 index 190ce922..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py +++ /dev/null @@ -1,185 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.fpo_objective import FPOObjective - globals()['FPOObjective'] = FPOObjective - - -class FPOOptimizerStrategyOverrides(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('constraints',): { - 'DISABLE': "Disable", - 'ENABLE': "Enable", - }, - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'objective': (FPOObjective,), # noqa: E501 - 'constraints': ({str: (str,)},), # noqa: E501 - 'alpha': (str,), # noqa: E501 - 'transaction_cost': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'objective': 'objective', # noqa: E501 - 'constraints': 'constraints', # noqa: E501 - 'alpha': 'alpha', # noqa: E501 - 'transaction_cost': 'transactionCost', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """FPOOptimizerStrategyOverrides - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - objective (FPOObjective): [optional] # noqa: E501 - constraints ({str: (str,)}): List of constraints. [optional] # noqa: E501 - alpha (str): Alpha. [optional] # noqa: E501 - transaction_cost (str): Transaction cost. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/group_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/group_root.py deleted file mode 100644 index b28550d1..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/group_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.group import Group - globals()['Group'] = Group - - -class GroupRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (Group,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """GroupRoot - a model defined in OpenAPI - - Args: - data ({str: (Group,)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template.py deleted file mode 100644 index 5ff02893..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template.py +++ /dev/null @@ -1,190 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes - globals()['TemplateContentTypes'] = TemplateContentTypes - - -class LinkedPATemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'directory': (str,), # noqa: E501 - 'snapshot': (bool,), # noqa: E501 - 'content': (TemplateContentTypes,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'parent_component_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'directory': 'directory', # noqa: E501 - 'snapshot': 'snapshot', # noqa: E501 - 'content': 'content', # noqa: E501 - 'id': 'id', # noqa: E501 - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'parent_component_id': 'parentComponentId', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LinkedPATemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - directory (str): Template directory.. [optional] # noqa: E501 - snapshot (bool): snapshot.. [optional] # noqa: E501 - content (TemplateContentTypes): [optional] # noqa: E501 - id (str): Template id.. [optional] # noqa: E501 - description (str): Template description.. [optional] # noqa: E501 - name (str): Template name.. [optional] # noqa: E501 - parent_component_id (str): Template parent tile.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters.py deleted file mode 100644 index 6a269ab8..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters.py +++ /dev/null @@ -1,185 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes - globals()['TemplateContentTypes'] = TemplateContentTypes - - -class LinkedPATemplateParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'directory': (str,), # noqa: E501 - 'parent_component_id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'content': (TemplateContentTypes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'directory': 'directory', # noqa: E501 - 'parent_component_id': 'parentComponentId', # noqa: E501 - 'description': 'description', # noqa: E501 - 'content': 'content', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, directory, parent_component_id, *args, **kwargs): # noqa: E501 - """LinkedPATemplateParameters - a model defined in OpenAPI - - Args: - directory (str): The directory to create a linked PA template - parent_component_id (str): Parent component id - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Template description. [optional] # noqa: E501 - content (TemplateContentTypes): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.directory = directory - self.parent_component_id = parent_component_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py deleted file mode 100644 index d364390e..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.linked_pa_template_parameters import LinkedPATemplateParameters - globals()['LinkedPATemplateParameters'] = LinkedPATemplateParameters - - -class LinkedPATemplateParametersRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (LinkedPATemplateParameters,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """LinkedPATemplateParametersRoot - a model defined in OpenAPI - - Args: - data (LinkedPATemplateParameters): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary.py deleted file mode 100644 index d80494aa..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary.py +++ /dev/null @@ -1,176 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class LinkedPATemplatePostSummary(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'parent_component_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'parent_component_id': 'parentComponentId', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LinkedPATemplatePostSummary - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): Template id.. [optional] # noqa: E501 - description (str): Template description.. [optional] # noqa: E501 - name (str): Template name.. [optional] # noqa: E501 - parent_component_id (str): Template parent tile.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py deleted file mode 100644 index a5adb81c..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.linked_pa_template_post_summary import LinkedPATemplatePostSummary - globals()['LinkedPATemplatePostSummary'] = LinkedPATemplatePostSummary - - -class LinkedPATemplatePostSummaryRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (LinkedPATemplatePostSummary,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """LinkedPATemplatePostSummaryRoot - a model defined in OpenAPI - - Args: - data (LinkedPATemplatePostSummary): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_root.py deleted file mode 100644 index cb01d4f6..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.linked_pa_template import LinkedPATemplate - globals()['LinkedPATemplate'] = LinkedPATemplate - - -class LinkedPATemplateRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (LinkedPATemplate,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """LinkedPATemplateRoot - a model defined in OpenAPI - - Args: - data (LinkedPATemplate): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary.py deleted file mode 100644 index 4ecced42..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class LinkedPATemplateSummary(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'parent_component_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'parent_component_id': 'parentComponentId', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LinkedPATemplateSummary - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Template description.. [optional] # noqa: E501 - name (str): Template name.. [optional] # noqa: E501 - parent_component_id (str): Template parent tile.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary_root.py deleted file mode 100644 index e781b212..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.linked_pa_template_summary import LinkedPATemplateSummary - globals()['LinkedPATemplateSummary'] = LinkedPATemplateSummary - - -class LinkedPATemplateSummaryRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (LinkedPATemplateSummary,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """LinkedPATemplateSummaryRoot - a model defined in OpenAPI - - Args: - data ({str: (LinkedPATemplateSummary,)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py deleted file mode 100644 index 7417226d..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes - globals()['TemplateContentTypes'] = TemplateContentTypes - - -class LinkedPATemplateUpdateParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'parent_component_id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'content': (TemplateContentTypes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'parent_component_id': 'parentComponentId', # noqa: E501 - 'description': 'description', # noqa: E501 - 'content': 'content', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LinkedPATemplateUpdateParameters - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - parent_component_id (str): Parent component id. [optional] # noqa: E501 - description (str): Template description. [optional] # noqa: E501 - content (TemplateContentTypes): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py deleted file mode 100644 index f71b046a..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.linked_pa_template_update_parameters import LinkedPATemplateUpdateParameters - globals()['LinkedPATemplateUpdateParameters'] = LinkedPATemplateUpdateParameters - - -class LinkedPATemplateUpdateParametersRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (LinkedPATemplateUpdateParameters,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """LinkedPATemplateUpdateParametersRoot - a model defined in OpenAPI - - Args: - data (LinkedPATemplateUpdateParameters): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_column.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_column.py deleted file mode 100644 index 3ca30ae9..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_column.py +++ /dev/null @@ -1,170 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PACalculationColumn(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'statistics': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'statistics': 'statistics', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACalculationColumn - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): FactSet-defined or User-defined Column identifier.. [optional] # noqa: E501 - statistics ([str]): Column Statistic identifier. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_data_sources.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_data_sources.py deleted file mode 100644 index 86a74fc8..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_data_sources.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_calculation_pricing_source import PACalculationPricingSource - globals()['PACalculationPricingSource'] = PACalculationPricingSource - - -class PACalculationDataSources(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'portfoliopricingsources': ([PACalculationPricingSource],), # noqa: E501 - 'benchmarkpricingsources': ([PACalculationPricingSource],), # noqa: E501 - 'useportfoliopricingsourcesforbenchmark': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'portfoliopricingsources': 'portfoliopricingsources', # noqa: E501 - 'benchmarkpricingsources': 'benchmarkpricingsources', # noqa: E501 - 'useportfoliopricingsourcesforbenchmark': 'useportfoliopricingsourcesforbenchmark', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACalculationDataSources - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - portfoliopricingsources ([PACalculationPricingSource]): List of portfilio pricing source for the PA calculation. [optional] # noqa: E501 - benchmarkpricingsources ([PACalculationPricingSource]): List of benchmark pricing source for the PA calculation. [optional] # noqa: E501 - useportfoliopricingsourcesforbenchmark (bool): Use portfolio pricing sources for benchmark. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_group.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_group.py deleted file mode 100644 index 68e30cf0..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_group.py +++ /dev/null @@ -1,170 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PACalculationGroup(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'frequency': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'frequency': 'frequency', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACalculationGroup - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): FactSet-defined or User-defined Group identifier.. [optional] # noqa: E501 - frequency (str): Grouping frequency. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters.py deleted file mode 100644 index 0dac14be..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters.py +++ /dev/null @@ -1,207 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn - from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources - from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup - from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters - from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier - globals()['PACalculationColumn'] = PACalculationColumn - globals()['PACalculationDataSources'] = PACalculationDataSources - globals()['PACalculationGroup'] = PACalculationGroup - globals()['PADateParameters'] = PADateParameters - globals()['PAIdentifier'] = PAIdentifier - - -class PACalculationParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'componentid': (str,), # noqa: E501 - 'accounts': ([PAIdentifier],), # noqa: E501 - 'benchmarks': ([PAIdentifier],), # noqa: E501 - 'dates': (PADateParameters,), # noqa: E501 - 'groups': ([PACalculationGroup],), # noqa: E501 - 'currencyisocode': (str,), # noqa: E501 - 'columns': ([PACalculationColumn],), # noqa: E501 - 'datasources': (PACalculationDataSources,), # noqa: E501 - 'componentdetail': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'componentid': 'componentid', # noqa: E501 - 'accounts': 'accounts', # noqa: E501 - 'benchmarks': 'benchmarks', # noqa: E501 - 'dates': 'dates', # noqa: E501 - 'groups': 'groups', # noqa: E501 - 'currencyisocode': 'currencyisocode', # noqa: E501 - 'columns': 'columns', # noqa: E501 - 'datasources': 'datasources', # noqa: E501 - 'componentdetail': 'componentdetail', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, componentid, *args, **kwargs): # noqa: E501 - """PACalculationParameters - a model defined in OpenAPI - - Args: - componentid (str): The PA Engine component identifier to analyze. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - accounts ([PAIdentifier]): List of accounts.. [optional] # noqa: E501 - benchmarks ([PAIdentifier]): List of benchmarks.. [optional] # noqa: E501 - dates (PADateParameters): [optional] # noqa: E501 - groups ([PACalculationGroup]): List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.. [optional] # noqa: E501 - currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 - columns ([PACalculationColumn]): List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.. [optional] # noqa: E501 - datasources (PACalculationDataSources): [optional] # noqa: E501 - componentdetail (str): Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.componentid = componentid - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters_root.py deleted file mode 100644 index b8000417..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters_root.py +++ /dev/null @@ -1,177 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.calculation_meta import CalculationMeta - from fds.analyticsapi.engines.model.pa_calculation_parameters import PACalculationParameters - globals()['CalculationMeta'] = CalculationMeta - globals()['PACalculationParameters'] = PACalculationParameters - - -class PACalculationParametersRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (PACalculationParameters,)},), # noqa: E501 - 'meta': (CalculationMeta,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACalculationParametersRoot - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - data ({str: (PACalculationParameters,)}): List of calculation parameters.. [optional] # noqa: E501 - meta (CalculationMeta): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_pricing_source.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_pricing_source.py deleted file mode 100644 index c24c6ebe..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_pricing_source.py +++ /dev/null @@ -1,167 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PACalculationPricingSource(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACalculationPricingSource - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): Pricing source identifier. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component.py deleted file mode 100644 index cc3bb3f3..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component.py +++ /dev/null @@ -1,198 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters - from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier - globals()['PADateParameters'] = PADateParameters - globals()['PAIdentifier'] = PAIdentifier - - -class PAComponent(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'accounts': ([PAIdentifier],), # noqa: E501 - 'benchmarks': ([PAIdentifier],), # noqa: E501 - 'currencyisocode': (str,), # noqa: E501 - 'dates': (PADateParameters,), # noqa: E501 - 'snapshot': (bool,), # noqa: E501 - 'path': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'accounts': 'accounts', # noqa: E501 - 'benchmarks': 'benchmarks', # noqa: E501 - 'currencyisocode': 'currencyisocode', # noqa: E501 - 'dates': 'dates', # noqa: E501 - 'snapshot': 'snapshot', # noqa: E501 - 'path': 'path', # noqa: E501 - 'name': 'name', # noqa: E501 - 'category': 'category', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PAComponent - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): Component identifier.. [optional] # noqa: E501 - accounts ([PAIdentifier]): List of accounts saved in the PA document.. [optional] # noqa: E501 - benchmarks ([PAIdentifier]): List of benchmarks saved in the PA document.. [optional] # noqa: E501 - currencyisocode (str): [optional] # noqa: E501 - dates (PADateParameters): [optional] # noqa: E501 - snapshot (bool): Is the component type snapshot or subperiod.. [optional] # noqa: E501 - path (str): The path to the document. [optional] # noqa: E501 - name (str): Component name.. [optional] # noqa: E501 - category (str): Component category.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_data.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_data.py deleted file mode 100644 index da54419e..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_data.py +++ /dev/null @@ -1,201 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn - from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources - from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup - from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters - from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier - globals()['PACalculationColumn'] = PACalculationColumn - globals()['PACalculationDataSources'] = PACalculationDataSources - globals()['PACalculationGroup'] = PACalculationGroup - globals()['PADateParameters'] = PADateParameters - globals()['PAIdentifier'] = PAIdentifier - - -class PAComponentData(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'accounts': ([PAIdentifier],), # noqa: E501 - 'benchmarks': ([PAIdentifier],), # noqa: E501 - 'groups': ([PACalculationGroup],), # noqa: E501 - 'columns': ([PACalculationColumn],), # noqa: E501 - 'dates': (PADateParameters,), # noqa: E501 - 'datasources': (PACalculationDataSources,), # noqa: E501 - 'currencyisocode': (str,), # noqa: E501 - 'componentdetail': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'accounts': 'accounts', # noqa: E501 - 'benchmarks': 'benchmarks', # noqa: E501 - 'groups': 'groups', # noqa: E501 - 'columns': 'columns', # noqa: E501 - 'dates': 'dates', # noqa: E501 - 'datasources': 'datasources', # noqa: E501 - 'currencyisocode': 'currencyisocode', # noqa: E501 - 'componentdetail': 'componentdetail', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PAComponentData - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - accounts ([PAIdentifier]): List of accounts.. [optional] # noqa: E501 - benchmarks ([PAIdentifier]): List of benchmarks.. [optional] # noqa: E501 - groups ([PACalculationGroup]): List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.. [optional] # noqa: E501 - columns ([PACalculationColumn]): List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.. [optional] # noqa: E501 - dates (PADateParameters): [optional] # noqa: E501 - datasources (PACalculationDataSources): [optional] # noqa: E501 - currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 - componentdetail (str): PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_root.py deleted file mode 100644 index f4313a19..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_component import PAComponent - globals()['PAComponent'] = PAComponent - - -class PAComponentRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (PAComponent,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """PAComponentRoot - a model defined in OpenAPI - - Args: - data (PAComponent): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_date_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_date_parameters.py deleted file mode 100644 index d66758ef..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_date_parameters.py +++ /dev/null @@ -1,177 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PADateParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'enddate': (str,), # noqa: E501 - 'frequency': (str,), # noqa: E501 - 'startdate': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'enddate': 'enddate', # noqa: E501 - 'frequency': 'frequency', # noqa: E501 - 'startdate': 'startdate', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, enddate, frequency, *args, **kwargs): # noqa: E501 - """PADateParameters - a model defined in OpenAPI - - Args: - enddate (str): Calculation's end date. - frequency (str): Calculation's frequency. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - startdate (str): Calculation's start date.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.enddate = enddate - self.frequency = frequency - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_doc.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_doc.py deleted file mode 100644 index f7f1e6ab..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_doc.py +++ /dev/null @@ -1,170 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PaDoc(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """PaDoc - a model defined in OpenAPI - - Args: - id (str): PA document path - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_identifier.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_identifier.py deleted file mode 100644 index 8345d42e..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_identifier.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PAIdentifier(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'holdingsmode': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'holdingsmode': 'holdingsmode', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 - """PAIdentifier - a model defined in OpenAPI - - Args: - id (str): User's FactSet account path OR benchmark. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - holdingsmode (str): Holdings Mode can be B&H, TBR, OMS , EXT or VLT.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.id = id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source.py deleted file mode 100644 index 18c85553..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PAPricingSource(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'directory': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'directory': 'directory', # noqa: E501 - 'category': 'category', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PAPricingSource - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Pricing source Name. [optional] # noqa: E501 - directory (str): Pricing source directory. [optional] # noqa: E501 - category (str): Pricing source category. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source_root.py deleted file mode 100644 index f2a03b10..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_pricing_source import PAPricingSource - globals()['PAPricingSource'] = PAPricingSource - - -class PAPricingSourceRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (PAPricingSource,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """PAPricingSourceRoot - a model defined in OpenAPI - - Args: - data ({str: (PAPricingSource,)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_date_list_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_date_list_obsolete.py deleted file mode 100644 index 616f7eed..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_date_list_obsolete.py +++ /dev/null @@ -1,180 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class QuantDateListObsolete(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'frequency': (str,), # noqa: E501 - 'calendar': (str,), # noqa: E501 - 'dates': ([str],), # noqa: E501 - 'override_universal_screen_calendar': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'frequency': 'frequency', # noqa: E501 - 'calendar': 'calendar', # noqa: E501 - 'dates': 'dates', # noqa: E501 - 'override_universal_screen_calendar': 'overrideUniversalScreenCalendar', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, frequency, calendar, *args, **kwargs): # noqa: E501 - """QuantDateListObsolete - a model defined in OpenAPI - - Args: - frequency (str): - calendar (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - dates ([str]): [optional] # noqa: E501 - override_universal_screen_calendar (bool): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.frequency = frequency - self.calendar = calendar - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fds_date_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fds_date_obsolete.py deleted file mode 100644 index e74b9022..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fds_date_obsolete.py +++ /dev/null @@ -1,185 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class QuantFdsDateObsolete(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'start_date': (str,), # noqa: E501 - 'end_date': (str,), # noqa: E501 - 'frequency': (str,), # noqa: E501 - 'calendar': (str,), # noqa: E501 - 'override_universal_screen_calendar': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'start_date': 'startDate', # noqa: E501 - 'end_date': 'endDate', # noqa: E501 - 'frequency': 'frequency', # noqa: E501 - 'calendar': 'calendar', # noqa: E501 - 'override_universal_screen_calendar': 'overrideUniversalScreenCalendar', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, start_date, end_date, frequency, calendar, *args, **kwargs): # noqa: E501 - """QuantFdsDateObsolete - a model defined in OpenAPI - - Args: - start_date (str): - end_date (str): - frequency (str): - calendar (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - override_universal_screen_calendar (bool): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.start_date = start_date - self.end_date = end_date - self.frequency = frequency - self.calendar = calendar - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py deleted file mode 100644 index f3980ea9..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py +++ /dev/null @@ -1,180 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class QuantFqlExpressionObsolete(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'expr': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'date_offset': (str,), # noqa: E501 - 'is_array_return_type': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'expr': 'expr', # noqa: E501 - 'name': 'name', # noqa: E501 - 'date_offset': 'dateOffset', # noqa: E501 - 'is_array_return_type': 'isArrayReturnType', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, expr, name, *args, **kwargs): # noqa: E501 - """QuantFqlExpressionObsolete - a model defined in OpenAPI - - Args: - expr (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - date_offset (str): [optional] # noqa: E501 - is_array_return_type (bool): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.expr = expr - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py deleted file mode 100644 index 190e45ca..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py +++ /dev/null @@ -1,186 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class QuantIdentifierUniverseObsolete(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('universe_type',): { - 'EQUITY': "Equity", - 'DEBT': "Debt", - }, - ('source',): { - 'SCREENINGEXPRESSIONUNIVERSE': "ScreeningExpressionUniverse", - 'UNIVERSALSCREENUNIVERSE': "UniversalScreenUniverse", - 'IDENTIFIERUNIVERSE': "IdentifierUniverse", - }, - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'universe_type': (str,), # noqa: E501 - 'identifiers': ([str],), # noqa: E501 - 'source': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'universe_type': 'universeType', # noqa: E501 - 'identifiers': 'identifiers', # noqa: E501 - 'source': 'source', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, universe_type, identifiers, *args, **kwargs): # noqa: E501 - """QuantIdentifierUniverseObsolete - a model defined in OpenAPI - - Args: - universe_type (str): - identifiers ([str]): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - source (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.universe_type = universe_type - self.identifiers = identifiers - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py deleted file mode 100644 index 8fa16f87..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py +++ /dev/null @@ -1,177 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class QuantScreeningExpressionObsolete(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'expr': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'date_offset': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'expr': 'expr', # noqa: E501 - 'name': 'name', # noqa: E501 - 'date_offset': 'dateOffset', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, expr, name, *args, **kwargs): # noqa: E501 - """QuantScreeningExpressionObsolete - a model defined in OpenAPI - - Args: - expr (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - date_offset (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.expr = expr - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py deleted file mode 100644 index 19848f8f..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py +++ /dev/null @@ -1,189 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class QuantScreeningExpressionUniverseObsolete(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('universe_type',): { - 'EQUITY': "Equity", - 'DEBT': "Debt", - }, - ('source',): { - 'SCREENINGEXPRESSIONUNIVERSE': "ScreeningExpressionUniverse", - 'UNIVERSALSCREENUNIVERSE': "UniversalScreenUniverse", - 'IDENTIFIERUNIVERSE': "IdentifierUniverse", - }, - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'universe_expr': (str,), # noqa: E501 - 'universe_type': (str,), # noqa: E501 - 'security_expr': (str,), # noqa: E501 - 'source': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'universe_expr': 'universeExpr', # noqa: E501 - 'universe_type': 'universeType', # noqa: E501 - 'security_expr': 'securityExpr', # noqa: E501 - 'source': 'source', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, universe_expr, universe_type, *args, **kwargs): # noqa: E501 - """QuantScreeningExpressionUniverseObsolete - a model defined in OpenAPI - - Args: - universe_expr (str): - universe_type (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - security_expr (str): [optional] # noqa: E501 - source (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.universe_expr = universe_expr - self.universe_type = universe_type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py deleted file mode 100644 index 6d3ecdd4..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py +++ /dev/null @@ -1,174 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class QuantUniversalScreenParameterObsolete(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'reference_name': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'reference_name': 'referenceName', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, reference_name, name, *args, **kwargs): # noqa: E501 - """QuantUniversalScreenParameterObsolete - a model defined in OpenAPI - - Args: - reference_name (str): - name (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.reference_name = reference_name - self.name = name - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py deleted file mode 100644 index 732831bd..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class QuantUniversalScreenUniverseObsolete(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('source',): { - 'SCREENINGEXPRESSIONUNIVERSE': "ScreeningExpressionUniverse", - 'UNIVERSALSCREENUNIVERSE': "UniversalScreenUniverse", - 'IDENTIFIERUNIVERSE': "IdentifierUniverse", - }, - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'screen': (str,), # noqa: E501 - 'source': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'screen': 'screen', # noqa: E501 - 'source': 'source', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, screen, *args, **kwargs): # noqa: E501 - """QuantUniversalScreenUniverseObsolete - a model defined in OpenAPI - - Args: - screen (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - source (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.screen = screen - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/spar_date_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/spar_date_parameters.py index aa48608a..4478b109 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/spar_date_parameters.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/spar_date_parameters.py @@ -76,6 +76,7 @@ def openapi_types(): 'startdate': (str,), # noqa: E501 'enddate': (str,), # noqa: E501 'frequency': (str,), # noqa: E501 + 'useeachportfolioinception': (bool,), # noqa: E501 } @cached_property @@ -87,6 +88,7 @@ def discriminator(): 'startdate': 'startdate', # noqa: E501 'enddate': 'enddate', # noqa: E501 'frequency': 'frequency', # noqa: E501 + 'useeachportfolioinception': 'useeachportfolioinception', # noqa: E501 } _composed_schemas = {} @@ -140,6 +142,7 @@ def __init__(self, startdate, enddate, frequency, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + useeachportfolioinception (bool): Use Each Portfolio Inception. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/template_content_types.py b/auto-generated-sdk/fds/analyticsapi/engines/model/template_content_types.py deleted file mode 100644 index d1d271f9..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/template_content_types.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class TemplateContentTypes(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'mandatory': ([str],), # noqa: E501 - 'optional': ([str],), # noqa: E501 - 'locked': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'mandatory': 'mandatory', # noqa: E501 - 'optional': 'optional', # noqa: E501 - 'locked': 'locked', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TemplateContentTypes - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - mandatory ([str]): Template mandatory fields. [optional] # noqa: E501 - optional ([str]): Template optional fields. [optional] # noqa: E501 - locked ([str]): Template locked fields. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component.py deleted file mode 100644 index c27be4e4..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component.py +++ /dev/null @@ -1,193 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_component_data import PAComponentData - globals()['PAComponentData'] = PAComponentData - - -class TemplatedPAComponent(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'directory': (str,), # noqa: E501 - 'snapshot': (bool,), # noqa: E501 - 'component_data': (PAComponentData,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'parent_template_id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'directory': 'directory', # noqa: E501 - 'snapshot': 'snapshot', # noqa: E501 - 'component_data': 'componentData', # noqa: E501 - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'parent_template_id': 'parentTemplateId', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TemplatedPAComponent - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - directory (str): [optional] # noqa: E501 - snapshot (bool): [optional] # noqa: E501 - component_data (PAComponentData): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - name (str): [optional] # noqa: E501 - parent_template_id (str): [optional] # noqa: E501 - type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters.py deleted file mode 100644 index bce9a33a..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters.py +++ /dev/null @@ -1,185 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_component_data import PAComponentData - globals()['PAComponentData'] = PAComponentData - - -class TemplatedPAComponentParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'directory': (str,), # noqa: E501 - 'parent_template_id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'component_data': (PAComponentData,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'directory': 'directory', # noqa: E501 - 'parent_template_id': 'parentTemplateId', # noqa: E501 - 'description': 'description', # noqa: E501 - 'component_data': 'componentData', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, directory, parent_template_id, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentParameters - a model defined in OpenAPI - - Args: - directory (str): Directory to create templated components - parent_template_id (str): Parent template id - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Component description.. [optional] # noqa: E501 - component_data (PAComponentData): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.directory = directory - self.parent_template_id = parent_template_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary.py deleted file mode 100644 index f7a0a345..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary.py +++ /dev/null @@ -1,179 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class TemplatedPAComponentPostSummary(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'parent_template_id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'parent_template_id': 'parentTemplateId', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentPostSummary - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): [optional] # noqa: E501 - description (str): [optional] # noqa: E501 - name (str): [optional] # noqa: E501 - parent_template_id (str): [optional] # noqa: E501 - type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py deleted file mode 100644 index 47f46386..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.templated_pa_component_post_summary import TemplatedPAComponentPostSummary - globals()['TemplatedPAComponentPostSummary'] = TemplatedPAComponentPostSummary - - -class TemplatedPAComponentPostSummaryRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (TemplatedPAComponentPostSummary,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentPostSummaryRoot - a model defined in OpenAPI - - Args: - data (TemplatedPAComponentPostSummary): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_root.py deleted file mode 100644 index 6121b0e8..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.templated_pa_component import TemplatedPAComponent - globals()['TemplatedPAComponent'] = TemplatedPAComponent - - -class TemplatedPAComponentRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (TemplatedPAComponent,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentRoot - a model defined in OpenAPI - - Args: - data (TemplatedPAComponent): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary.py deleted file mode 100644 index 1c2c84cc..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary.py +++ /dev/null @@ -1,176 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class TemplatedPAComponentSummary(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'parent_template_id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'parent_template_id': 'parentTemplateId', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentSummary - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): [optional] # noqa: E501 - name (str): [optional] # noqa: E501 - parent_template_id (str): [optional] # noqa: E501 - type (str): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary_root.py deleted file mode 100644 index ec00aa3a..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.templated_pa_component_summary import TemplatedPAComponentSummary - globals()['TemplatedPAComponentSummary'] = TemplatedPAComponentSummary - - -class TemplatedPAComponentSummaryRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (TemplatedPAComponentSummary,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentSummaryRoot - a model defined in OpenAPI - - Args: - data ({str: (TemplatedPAComponentSummary,)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py deleted file mode 100644 index 2276100b..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_component_data import PAComponentData - globals()['PAComponentData'] = PAComponentData - - -class TemplatedPAComponentUpdateParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'parent_template_id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'component_data': (PAComponentData,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'parent_template_id': 'parentTemplateId', # noqa: E501 - 'description': 'description', # noqa: E501 - 'component_data': 'componentData', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentUpdateParameters - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - parent_template_id (str): Parent template id. [optional] # noqa: E501 - description (str): Component description.. [optional] # noqa: E501 - component_data (PAComponentData): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py deleted file mode 100644 index 477e0bd3..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.templated_pa_component_update_parameters import TemplatedPAComponentUpdateParameters - globals()['TemplatedPAComponentUpdateParameters'] = TemplatedPAComponentUpdateParameters - - -class TemplatedPAComponentUpdateParametersRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (TemplatedPAComponentUpdateParameters,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentUpdateParametersRoot - a model defined in OpenAPI - - Args: - data (TemplatedPAComponentUpdateParameters): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template.py deleted file mode 100644 index f6d57bff..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template.py +++ /dev/null @@ -1,227 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn - from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources - from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup - from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters - from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier - from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes - globals()['PACalculationColumn'] = PACalculationColumn - globals()['PACalculationDataSources'] = PACalculationDataSources - globals()['PACalculationGroup'] = PACalculationGroup - globals()['PADateParameters'] = PADateParameters - globals()['PAIdentifier'] = PAIdentifier - globals()['TemplateContentTypes'] = TemplateContentTypes - - -class UnlinkedPATemplate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'directory': (str,), # noqa: E501 - 'template_type_id': (str,), # noqa: E501 - 'snapshot': (bool,), # noqa: E501 - 'accounts': ([PAIdentifier],), # noqa: E501 - 'benchmarks': ([PAIdentifier],), # noqa: E501 - 'columns': ([PACalculationColumn],), # noqa: E501 - 'dates': (PADateParameters,), # noqa: E501 - 'groups': ([PACalculationGroup],), # noqa: E501 - 'datasources': (PACalculationDataSources,), # noqa: E501 - 'currencyisocode': (str,), # noqa: E501 - 'componentdetail': (str,), # noqa: E501 - 'content': (TemplateContentTypes,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'directory': 'directory', # noqa: E501 - 'template_type_id': 'templateTypeId', # noqa: E501 - 'snapshot': 'snapshot', # noqa: E501 - 'accounts': 'accounts', # noqa: E501 - 'benchmarks': 'benchmarks', # noqa: E501 - 'columns': 'columns', # noqa: E501 - 'dates': 'dates', # noqa: E501 - 'groups': 'groups', # noqa: E501 - 'datasources': 'datasources', # noqa: E501 - 'currencyisocode': 'currencyisocode', # noqa: E501 - 'componentdetail': 'componentdetail', # noqa: E501 - 'content': 'content', # noqa: E501 - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'category': 'category', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): Template id.. [optional] # noqa: E501 - directory (str): Template directory.. [optional] # noqa: E501 - template_type_id (str): Template type id. [optional] # noqa: E501 - snapshot (bool): snapshot.. [optional] # noqa: E501 - accounts ([PAIdentifier]): List of accounts. [optional] # noqa: E501 - benchmarks ([PAIdentifier]): List of benchmarks. [optional] # noqa: E501 - columns ([PACalculationColumn]): List of columns for the PA calculation. [optional] # noqa: E501 - dates (PADateParameters): [optional] # noqa: E501 - groups ([PACalculationGroup]): List of groupings for the PA calculation. [optional] # noqa: E501 - datasources (PACalculationDataSources): [optional] # noqa: E501 - currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 - componentdetail (str): PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 - content (TemplateContentTypes): [optional] # noqa: E501 - description (str): Template description.. [optional] # noqa: E501 - name (str): Template name.. [optional] # noqa: E501 - category (str): Unlinked template category. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py deleted file mode 100644 index ec303664..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py +++ /dev/null @@ -1,170 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class UnlinkedPATemplateCategoryAndType(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'category': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'category': 'category', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateCategoryAndType - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - category (str): Unlinked template category. [optional] # noqa: E501 - name (str): Unlinked template type. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py deleted file mode 100644 index 799928d3..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py +++ /dev/null @@ -1,189 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.unlinked_pa_template_column_details import UnlinkedPATemplateColumnDetails - from fds.analyticsapi.engines.model.unlinked_pa_template_group_details import UnlinkedPATemplateGroupDetails - globals()['UnlinkedPATemplateColumnDetails'] = UnlinkedPATemplateColumnDetails - globals()['UnlinkedPATemplateGroupDetails'] = UnlinkedPATemplateGroupDetails - - -class UnlinkedPATemplateCategoryAndTypeDetails(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'id': (str,), # noqa: E501 - 'columns': ([UnlinkedPATemplateColumnDetails],), # noqa: E501 - 'groups': ([UnlinkedPATemplateGroupDetails],), # noqa: E501 - 'snapshot': (bool,), # noqa: E501 - 'category': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'columns': 'columns', # noqa: E501 - 'groups': 'groups', # noqa: E501 - 'snapshot': 'snapshot', # noqa: E501 - 'category': 'category', # noqa: E501 - 'name': 'name', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateCategoryAndTypeDetails - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): Type Id. [optional] # noqa: E501 - columns ([UnlinkedPATemplateColumnDetails]): List of default columns. [optional] # noqa: E501 - groups ([UnlinkedPATemplateGroupDetails]): List of default groupings. [optional] # noqa: E501 - snapshot (bool): Snapshot. [optional] # noqa: E501 - category (str): Unlinked template category. [optional] # noqa: E501 - name (str): Unlinked template type. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py deleted file mode 100644 index d4bda796..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details import UnlinkedPATemplateCategoryAndTypeDetails - globals()['UnlinkedPATemplateCategoryAndTypeDetails'] = UnlinkedPATemplateCategoryAndTypeDetails - - -class UnlinkedPATemplateCategoryAndTypeDetailsRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (UnlinkedPATemplateCategoryAndTypeDetails,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateCategoryAndTypeDetailsRoot - a model defined in OpenAPI - - Args: - data (UnlinkedPATemplateCategoryAndTypeDetails): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py deleted file mode 100644 index 7f3139c5..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type import UnlinkedPATemplateCategoryAndType - globals()['UnlinkedPATemplateCategoryAndType'] = UnlinkedPATemplateCategoryAndType - - -class UnlinkedPATemplateCategoryAndTypeRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (UnlinkedPATemplateCategoryAndType,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateCategoryAndTypeRoot - a model defined in OpenAPI - - Args: - data ({str: (UnlinkedPATemplateCategoryAndType,)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py deleted file mode 100644 index 3bd64faa..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class UnlinkedPATemplateColumnDetails(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'statistics': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'id': 'id', # noqa: E501 - 'statistics': 'statistics', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateColumnDetails - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Unlinked template column name. [optional] # noqa: E501 - id (str): FactSet-defined or User-defined Column identifier.. [optional] # noqa: E501 - statistics ([str]): Column Statistic identifier. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py deleted file mode 100644 index 5793b5f8..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class UnlinkedPATemplateGroupDetails(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'id': (str,), # noqa: E501 - 'frequency': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'id': 'id', # noqa: E501 - 'frequency': 'frequency', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateGroupDetails - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): Unlinked template group name. [optional] # noqa: E501 - id (str): FactSet-defined or User-defined Group identifier.. [optional] # noqa: E501 - frequency (str): Grouping frequency. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py deleted file mode 100644 index 58d2d207..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py +++ /dev/null @@ -1,219 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn - from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources - from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup - from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters - from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier - from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes - globals()['PACalculationColumn'] = PACalculationColumn - globals()['PACalculationDataSources'] = PACalculationDataSources - globals()['PACalculationGroup'] = PACalculationGroup - globals()['PADateParameters'] = PADateParameters - globals()['PAIdentifier'] = PAIdentifier - globals()['TemplateContentTypes'] = TemplateContentTypes - - -class UnlinkedPATemplateParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'directory': (str,), # noqa: E501 - 'template_type_id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'accounts': ([PAIdentifier],), # noqa: E501 - 'benchmarks': ([PAIdentifier],), # noqa: E501 - 'columns': ([PACalculationColumn],), # noqa: E501 - 'dates': (PADateParameters,), # noqa: E501 - 'groups': ([PACalculationGroup],), # noqa: E501 - 'datasources': (PACalculationDataSources,), # noqa: E501 - 'currencyisocode': (str,), # noqa: E501 - 'componentdetail': (str,), # noqa: E501 - 'content': (TemplateContentTypes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'directory': 'directory', # noqa: E501 - 'template_type_id': 'templateTypeId', # noqa: E501 - 'description': 'description', # noqa: E501 - 'accounts': 'accounts', # noqa: E501 - 'benchmarks': 'benchmarks', # noqa: E501 - 'columns': 'columns', # noqa: E501 - 'dates': 'dates', # noqa: E501 - 'groups': 'groups', # noqa: E501 - 'datasources': 'datasources', # noqa: E501 - 'currencyisocode': 'currencyisocode', # noqa: E501 - 'componentdetail': 'componentdetail', # noqa: E501 - 'content': 'content', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, directory, template_type_id, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateParameters - a model defined in OpenAPI - - Args: - directory (str): The directory to create an unlinked PA template - template_type_id (str): Template type id - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Template description. [optional] # noqa: E501 - accounts ([PAIdentifier]): List of accounts. [optional] # noqa: E501 - benchmarks ([PAIdentifier]): List of benchmarks. [optional] # noqa: E501 - columns ([PACalculationColumn]): List of columns for the PA calculation. [optional] # noqa: E501 - dates (PADateParameters): [optional] # noqa: E501 - groups ([PACalculationGroup]): List of groupings for the PA calculation. [optional] # noqa: E501 - datasources (PACalculationDataSources): [optional] # noqa: E501 - currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 - componentdetail (str): PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 - content (TemplateContentTypes): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.directory = directory - self.template_type_id = template_type_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py deleted file mode 100644 index 3e40030a..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.unlinked_pa_template_parameters import UnlinkedPATemplateParameters - globals()['UnlinkedPATemplateParameters'] = UnlinkedPATemplateParameters - - -class UnlinkedPATemplateParametersRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (UnlinkedPATemplateParameters,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateParametersRoot - a model defined in OpenAPI - - Args: - data (UnlinkedPATemplateParameters): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py deleted file mode 100644 index 7c0790e6..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py +++ /dev/null @@ -1,176 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class UnlinkedPATemplatePostSummary(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'id': (str,), # noqa: E501 - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'id': 'id', # noqa: E501 - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'category': 'category', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplatePostSummary - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - id (str): Template id.. [optional] # noqa: E501 - description (str): Template description.. [optional] # noqa: E501 - name (str): Template name.. [optional] # noqa: E501 - category (str): Unlinked template category. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py deleted file mode 100644 index e523979c..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary import UnlinkedPATemplatePostSummary - globals()['UnlinkedPATemplatePostSummary'] = UnlinkedPATemplatePostSummary - - -class UnlinkedPATemplatePostSummaryRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (UnlinkedPATemplatePostSummary,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplatePostSummaryRoot - a model defined in OpenAPI - - Args: - data (UnlinkedPATemplatePostSummary): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_root.py deleted file mode 100644 index 2199f5af..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.unlinked_pa_template import UnlinkedPATemplate - globals()['UnlinkedPATemplate'] = UnlinkedPATemplate - - -class UnlinkedPATemplateRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (UnlinkedPATemplate,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateRoot - a model defined in OpenAPI - - Args: - data (UnlinkedPATemplate): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary.py deleted file mode 100644 index 1cad6d39..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class UnlinkedPATemplateSummary(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'description': (str,), # noqa: E501 - 'name': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'description': 'description', # noqa: E501 - 'name': 'name', # noqa: E501 - 'category': 'category', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateSummary - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Template description.. [optional] # noqa: E501 - name (str): Template name.. [optional] # noqa: E501 - category (str): Unlinked template category. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py deleted file mode 100644 index f786f561..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.unlinked_pa_template_summary import UnlinkedPATemplateSummary - globals()['UnlinkedPATemplateSummary'] = UnlinkedPATemplateSummary - - -class UnlinkedPATemplateSummaryRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': ({str: (UnlinkedPATemplateSummary,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateSummaryRoot - a model defined in OpenAPI - - Args: - data ({str: (UnlinkedPATemplateSummary,)}): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py deleted file mode 100644 index bdc81b26..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py +++ /dev/null @@ -1,209 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn - from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources - from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup - from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters - from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier - from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes - globals()['PACalculationColumn'] = PACalculationColumn - globals()['PACalculationDataSources'] = PACalculationDataSources - globals()['PACalculationGroup'] = PACalculationGroup - globals()['PADateParameters'] = PADateParameters - globals()['PAIdentifier'] = PAIdentifier - globals()['TemplateContentTypes'] = TemplateContentTypes - - -class UnlinkedPATemplateUpdateParameters(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'description': (str,), # noqa: E501 - 'accounts': ([PAIdentifier],), # noqa: E501 - 'benchmarks': ([PAIdentifier],), # noqa: E501 - 'columns': ([PACalculationColumn],), # noqa: E501 - 'dates': (PADateParameters,), # noqa: E501 - 'groups': ([PACalculationGroup],), # noqa: E501 - 'datasources': (PACalculationDataSources,), # noqa: E501 - 'currencyisocode': (str,), # noqa: E501 - 'componentdetail': (str,), # noqa: E501 - 'content': (TemplateContentTypes,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'description': 'description', # noqa: E501 - 'accounts': 'accounts', # noqa: E501 - 'benchmarks': 'benchmarks', # noqa: E501 - 'columns': 'columns', # noqa: E501 - 'dates': 'dates', # noqa: E501 - 'groups': 'groups', # noqa: E501 - 'datasources': 'datasources', # noqa: E501 - 'currencyisocode': 'currencyisocode', # noqa: E501 - 'componentdetail': 'componentdetail', # noqa: E501 - 'content': 'content', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateUpdateParameters - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - description (str): Template description. [optional] # noqa: E501 - accounts ([PAIdentifier]): List of accounts. [optional] # noqa: E501 - benchmarks ([PAIdentifier]): List of benchmarks. [optional] # noqa: E501 - columns ([PACalculationColumn]): List of columns for the PA calculation. [optional] # noqa: E501 - dates (PADateParameters): [optional] # noqa: E501 - groups ([PACalculationGroup]): List of groupings for the PA calculation. [optional] # noqa: E501 - datasources (PACalculationDataSources): [optional] # noqa: E501 - currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 - componentdetail (str): PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 - content (TemplateContentTypes): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py deleted file mode 100644 index 26ccddc4..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters import UnlinkedPATemplateUpdateParameters - globals()['UnlinkedPATemplateUpdateParameters'] = UnlinkedPATemplateUpdateParameters - - -class UnlinkedPATemplateUpdateParametersRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (UnlinkedPATemplateUpdateParameters,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """UnlinkedPATemplateUpdateParametersRoot - a model defined in OpenAPI - - Args: - data (UnlinkedPATemplateUpdateParameters): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/group.py b/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response.py similarity index 91% rename from auto-generated-sdk/fds/analyticsapi/engines/model/group.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response.py index 34f0edbf..c9c675a1 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/group.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response.py @@ -28,7 +28,7 @@ ) -class Group(ModelNormal): +class VaultAttributionLoaderResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -73,9 +73,9 @@ def openapi_types(): and the value is attribute type. """ return { - 'name': (str,), # noqa: E501 - 'directory': (str,), # noqa: E501 - 'category': (str,), # noqa: E501 + 'process_id': (str,), # noqa: E501 + 'group_id': (str,), # noqa: E501 + 'object_id': (str,), # noqa: E501 } @cached_property @@ -84,9 +84,9 @@ def discriminator(): attribute_map = { - 'name': 'name', # noqa: E501 - 'directory': 'directory', # noqa: E501 - 'category': 'category', # noqa: E501 + 'process_id': 'processId', # noqa: E501 + 'group_id': 'groupId', # noqa: E501 + 'object_id': 'objectId', # noqa: E501 } _composed_schemas = {} @@ -102,7 +102,7 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """Group - a model defined in OpenAPI + """VaultAttributionLoaderResponse - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -135,9 +135,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - name (str): Group Name. [optional] # noqa: E501 - directory (str): Group Directory. [optional] # noqa: E501 - category (str): Group Category. [optional] # noqa: E501 + process_id (str): ProcessId.. [optional] # noqa: E501 + group_id (str): GroupId.. [optional] # noqa: E501 + object_id (str): ObjectId.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py similarity index 94% rename from auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py index a0cc6efd..000a7dfe 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py @@ -28,11 +28,11 @@ ) def lazy_import(): - from fds.analyticsapi.engines.model.templated_pa_component_parameters import TemplatedPAComponentParameters - globals()['TemplatedPAComponentParameters'] = TemplatedPAComponentParameters + from fds.analyticsapi.engines.model.vault_attribution_loader_response import VaultAttributionLoaderResponse + globals()['VaultAttributionLoaderResponse'] = VaultAttributionLoaderResponse -class TemplatedPAComponentParametersRoot(ModelNormal): +class VaultAttributionLoaderResponseRoot(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -78,7 +78,7 @@ def openapi_types(): """ lazy_import() return { - 'data': (TemplatedPAComponentParameters,), # noqa: E501 + 'data': (VaultAttributionLoaderResponse,), # noqa: E501 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 } @@ -105,10 +105,10 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, data, *args, **kwargs): # noqa: E501 - """TemplatedPAComponentParametersRoot - a model defined in OpenAPI + """VaultAttributionLoaderResponseRoot - a model defined in OpenAPI Args: - data (TemplatedPAComponentParameters): + data (VaultAttributionLoaderResponse): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py index b2d0861a..29484259 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py @@ -36,12 +36,6 @@ from fds.analyticsapi.engines.model.calculations_summary import CalculationsSummary from fds.analyticsapi.engines.model.calculations_summary_root import CalculationsSummaryRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.column import Column -from fds.analyticsapi.engines.model.column_root import ColumnRoot -from fds.analyticsapi.engines.model.column_statistic import ColumnStatistic -from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot -from fds.analyticsapi.engines.model.column_summary import ColumnSummary -from fds.analyticsapi.engines.model.column_summary_root import ColumnSummaryRoot from fds.analyticsapi.engines.model.component_summary import ComponentSummary from fds.analyticsapi.engines.model.component_summary_root import ComponentSummaryRoot from fds.analyticsapi.engines.model.configuration_account import ConfigurationAccount @@ -67,6 +61,7 @@ from fds.analyticsapi.engines.model.fi_calculation_parameters import FICalculationParameters from fds.analyticsapi.engines.model.fi_calculation_parameters_root import FICalculationParametersRoot from fds.analyticsapi.engines.model.fi_cashflows import FICashflows +from fds.analyticsapi.engines.model.fi_convertible_settings import FIConvertibleSettings from fds.analyticsapi.engines.model.fi_discount_curve_info import FIDiscountCurveInfo from fds.analyticsapi.engines.model.fi_discount_curve_info_root import FIDiscountCurveInfoRoot from fds.analyticsapi.engines.model.fi_job_settings import FIJobSettings @@ -83,26 +78,8 @@ from fds.analyticsapi.engines.model.fi_servicer_advances_for_securities import FIServicerAdvancesForSecurities from fds.analyticsapi.engines.model.fi_structured_products_for_job_settings import FIStructuredProductsForJobSettings from fds.analyticsapi.engines.model.fi_structured_products_for_securities import FIStructuredProductsForSecurities -from fds.analyticsapi.engines.model.fpo_account import FPOAccount -from fds.analyticsapi.engines.model.fpo_objective import FPOObjective -from fds.analyticsapi.engines.model.fpo_optimization_parameters import FPOOptimizationParameters -from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot -from fds.analyticsapi.engines.model.fpo_optimizer_strategy import FPOOptimizerStrategy -from fds.analyticsapi.engines.model.fpo_optimizer_strategy_overrides import FPOOptimizerStrategyOverrides from fds.analyticsapi.engines.model.frequency import Frequency from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot -from fds.analyticsapi.engines.model.group import Group -from fds.analyticsapi.engines.model.group_root import GroupRoot -from fds.analyticsapi.engines.model.linked_pa_template import LinkedPATemplate -from fds.analyticsapi.engines.model.linked_pa_template_parameters import LinkedPATemplateParameters -from fds.analyticsapi.engines.model.linked_pa_template_parameters_root import LinkedPATemplateParametersRoot -from fds.analyticsapi.engines.model.linked_pa_template_post_summary import LinkedPATemplatePostSummary -from fds.analyticsapi.engines.model.linked_pa_template_post_summary_root import LinkedPATemplatePostSummaryRoot -from fds.analyticsapi.engines.model.linked_pa_template_root import LinkedPATemplateRoot -from fds.analyticsapi.engines.model.linked_pa_template_summary import LinkedPATemplateSummary -from fds.analyticsapi.engines.model.linked_pa_template_summary_root import LinkedPATemplateSummaryRoot -from fds.analyticsapi.engines.model.linked_pa_template_update_parameters import LinkedPATemplateUpdateParameters -from fds.analyticsapi.engines.model.linked_pa_template_update_parameters_root import LinkedPATemplateUpdateParametersRoot from fds.analyticsapi.engines.model.npo_optimization_parameters import NPOOptimizationParameters from fds.analyticsapi.engines.model.npo_optimization_parameters_root import NPOOptimizationParametersRoot from fds.analyticsapi.engines.model.npo_optimizer_strategy import NPOOptimizerStrategy @@ -115,20 +92,6 @@ from fds.analyticsapi.engines.model.optimizer_optimal_holdings import OptimizerOptimalHoldings from fds.analyticsapi.engines.model.optimizer_output_types import OptimizerOutputTypes from fds.analyticsapi.engines.model.optimizer_trades_list import OptimizerTradesList -from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn -from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources -from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup -from fds.analyticsapi.engines.model.pa_calculation_parameters import PACalculationParameters -from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot -from fds.analyticsapi.engines.model.pa_calculation_pricing_source import PACalculationPricingSource -from fds.analyticsapi.engines.model.pa_component import PAComponent -from fds.analyticsapi.engines.model.pa_component_data import PAComponentData -from fds.analyticsapi.engines.model.pa_component_root import PAComponentRoot -from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters -from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier -from fds.analyticsapi.engines.model.pa_pricing_source import PAPricingSource -from fds.analyticsapi.engines.model.pa_pricing_source_root import PAPricingSourceRoot -from fds.analyticsapi.engines.model.pa_doc import PaDoc from fds.analyticsapi.engines.model.pagination_info import PaginationInfo from fds.analyticsapi.engines.model.pagination_meta import PaginationMeta from fds.analyticsapi.engines.model.pub_calculation_parameters import PubCalculationParameters @@ -141,22 +104,14 @@ from fds.analyticsapi.engines.model.quant_calculation_parameters_root import QuantCalculationParametersRoot from fds.analyticsapi.engines.model.quant_date import QuantDate from fds.analyticsapi.engines.model.quant_date_list import QuantDateList -from fds.analyticsapi.engines.model.quant_date_list_obsolete import QuantDateListObsolete from fds.analyticsapi.engines.model.quant_fds_date import QuantFdsDate -from fds.analyticsapi.engines.model.quant_fds_date_obsolete import QuantFdsDateObsolete from fds.analyticsapi.engines.model.quant_formula import QuantFormula from fds.analyticsapi.engines.model.quant_fql_expression import QuantFqlExpression -from fds.analyticsapi.engines.model.quant_fql_expression_obsolete import QuantFqlExpressionObsolete from fds.analyticsapi.engines.model.quant_identifier_universe import QuantIdentifierUniverse -from fds.analyticsapi.engines.model.quant_identifier_universe_obsolete import QuantIdentifierUniverseObsolete from fds.analyticsapi.engines.model.quant_screening_expression import QuantScreeningExpression -from fds.analyticsapi.engines.model.quant_screening_expression_obsolete import QuantScreeningExpressionObsolete from fds.analyticsapi.engines.model.quant_screening_expression_universe import QuantScreeningExpressionUniverse -from fds.analyticsapi.engines.model.quant_screening_expression_universe_obsolete import QuantScreeningExpressionUniverseObsolete from fds.analyticsapi.engines.model.quant_universal_screen_parameter import QuantUniversalScreenParameter -from fds.analyticsapi.engines.model.quant_universal_screen_parameter_obsolete import QuantUniversalScreenParameterObsolete from fds.analyticsapi.engines.model.quant_universal_screen_universe import QuantUniversalScreenUniverse -from fds.analyticsapi.engines.model.quant_universal_screen_universe_obsolete import QuantUniversalScreenUniverseObsolete from fds.analyticsapi.engines.model.quant_universe import QuantUniverse from fds.analyticsapi.engines.model.return_type import ReturnType from fds.analyticsapi.engines.model.spar_accounts import SPARAccounts @@ -169,33 +124,8 @@ from fds.analyticsapi.engines.model.spar_component_root import SPARComponentRoot from fds.analyticsapi.engines.model.spar_date_parameters import SPARDateParameters from fds.analyticsapi.engines.model.spar_identifier import SPARIdentifier -from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes -from fds.analyticsapi.engines.model.templated_pa_component import TemplatedPAComponent -from fds.analyticsapi.engines.model.templated_pa_component_parameters import TemplatedPAComponentParameters -from fds.analyticsapi.engines.model.templated_pa_component_parameters_root import TemplatedPAComponentParametersRoot -from fds.analyticsapi.engines.model.templated_pa_component_post_summary import TemplatedPAComponentPostSummary -from fds.analyticsapi.engines.model.templated_pa_component_post_summary_root import TemplatedPAComponentPostSummaryRoot -from fds.analyticsapi.engines.model.templated_pa_component_root import TemplatedPAComponentRoot -from fds.analyticsapi.engines.model.templated_pa_component_summary import TemplatedPAComponentSummary -from fds.analyticsapi.engines.model.templated_pa_component_summary_root import TemplatedPAComponentSummaryRoot -from fds.analyticsapi.engines.model.templated_pa_component_update_parameters import TemplatedPAComponentUpdateParameters -from fds.analyticsapi.engines.model.templated_pa_component_update_parameters_root import TemplatedPAComponentUpdateParametersRoot -from fds.analyticsapi.engines.model.unlinked_pa_template import UnlinkedPATemplate -from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type import UnlinkedPATemplateCategoryAndType -from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details import UnlinkedPATemplateCategoryAndTypeDetails -from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details_root import UnlinkedPATemplateCategoryAndTypeDetailsRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_root import UnlinkedPATemplateCategoryAndTypeRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_column_details import UnlinkedPATemplateColumnDetails -from fds.analyticsapi.engines.model.unlinked_pa_template_group_details import UnlinkedPATemplateGroupDetails -from fds.analyticsapi.engines.model.unlinked_pa_template_parameters import UnlinkedPATemplateParameters -from fds.analyticsapi.engines.model.unlinked_pa_template_parameters_root import UnlinkedPATemplateParametersRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary import UnlinkedPATemplatePostSummary -from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary_root import UnlinkedPATemplatePostSummaryRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_root import UnlinkedPATemplateRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_summary import UnlinkedPATemplateSummary -from fds.analyticsapi.engines.model.unlinked_pa_template_summary_root import UnlinkedPATemplateSummaryRoot -from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters import UnlinkedPATemplateUpdateParameters -from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters_root import UnlinkedPATemplateUpdateParametersRoot +from fds.analyticsapi.engines.model.vault_attribution_loader_response import VaultAttributionLoaderResponse +from fds.analyticsapi.engines.model.vault_attribution_loader_response_root import VaultAttributionLoaderResponseRoot from fds.analyticsapi.engines.model.vault_calculation_parameters import VaultCalculationParameters from fds.analyticsapi.engines.model.vault_calculation_parameters_root import VaultCalculationParametersRoot from fds.analyticsapi.engines.model.vault_component import VaultComponent diff --git a/auto-generated-sdk/setup.py b/auto-generated-sdk/setup.py index 98f84593..c122710d 100644 --- a/auto-generated-sdk/setup.py +++ b/auto-generated-sdk/setup.py @@ -14,7 +14,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "fds.analyticsapi.engines" -VERSION = "6.0.0" +VERSION = "6.1.0-rc.1" # To install the library, run the following # # python setup.py install From a8cee0ba65acfa80f9a08fc2b1294cdb14e77b52 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Wed, 15 Oct 2025 18:04:21 +0000 Subject: [PATCH 02/10] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.1.0 --- auto-generated-sdk/.openapi-generator/FILES | 174 +++ auto-generated-sdk/README.md | 124 ++ auto-generated-sdk/docs/Column.md | 14 + auto-generated-sdk/docs/ColumnRoot.md | 12 + auto-generated-sdk/docs/ColumnStatistic.md | 11 + .../docs/ColumnStatisticRoot.md | 12 + .../docs/ColumnStatisticsApi.md | 95 ++ auto-generated-sdk/docs/ColumnSummary.md | 14 + auto-generated-sdk/docs/ColumnSummaryRoot.md | 12 + auto-generated-sdk/docs/ColumnsApi.md | 197 +++ auto-generated-sdk/docs/ComponentsApi.md | 186 +++ auto-generated-sdk/docs/ConfigurationsApi.md | 92 ++ auto-generated-sdk/docs/DatesApi.md | 108 ++ auto-generated-sdk/docs/DocumentsApi.md | 93 ++ auto-generated-sdk/docs/FPOAccount.md | 13 + auto-generated-sdk/docs/FPOObjective.md | 12 + .../docs/FPOOptimizationParameters.md | 14 + .../docs/FPOOptimizationParametersRoot.md | 12 + auto-generated-sdk/docs/FPOOptimizerApi.md | 708 +++++++++ .../docs/FPOOptimizerStrategy.md | 12 + .../docs/FPOOptimizerStrategyOverrides.md | 14 + auto-generated-sdk/docs/FrequenciesApi.md | 86 ++ auto-generated-sdk/docs/Group.md | 13 + auto-generated-sdk/docs/GroupRoot.md | 12 + auto-generated-sdk/docs/GroupsApi.md | 181 +++ auto-generated-sdk/docs/LinkedPATemplate.md | 17 + .../docs/LinkedPATemplateParameters.md | 14 + .../docs/LinkedPATemplateParametersRoot.md | 12 + .../docs/LinkedPATemplatePostSummary.md | 14 + .../docs/LinkedPATemplatePostSummaryRoot.md | 12 + .../docs/LinkedPATemplateRoot.md | 12 + .../docs/LinkedPATemplateSummary.md | 13 + .../docs/LinkedPATemplateSummaryRoot.md | 12 + .../docs/LinkedPATemplateUpdateParameters.md | 13 + .../LinkedPATemplateUpdateParametersRoot.md | 12 + .../docs/LinkedPATemplatesApi.md | 516 +++++++ auto-generated-sdk/docs/Metadata.md | 16 + .../docs/PACalculationColumn.md | 12 + .../docs/PACalculationDataSources.md | 13 + auto-generated-sdk/docs/PACalculationGroup.md | 12 + .../docs/PACalculationParameters.md | 19 + .../docs/PACalculationParametersRoot.md | 12 + .../docs/PACalculationPricingSource.md | 11 + auto-generated-sdk/docs/PACalculationsApi.md | 1098 ++++++++++++++ auto-generated-sdk/docs/PACommentary.md | 13 + .../docs/PACommentaryConfigurationSummary.md | 12 + .../PACommentaryConfigurationSummaryRoot.md | 12 + auto-generated-sdk/docs/PACommentaryDate.md | 12 + .../docs/PACommentaryGetStatus.md | 13 + .../docs/PACommentaryGetStatusRoot.md | 12 + .../docs/PACommentaryParameters.md | 11 + .../docs/PACommentaryParametersRoot.md | 12 + auto-generated-sdk/docs/PACommentaryRoot.md | 12 + auto-generated-sdk/docs/PACommentaryStatus.md | 14 + .../docs/PACommentaryStatusRoot.md | 12 + auto-generated-sdk/docs/PAComponent.md | 19 + auto-generated-sdk/docs/PAComponentData.md | 18 + auto-generated-sdk/docs/PAComponentRoot.md | 12 + auto-generated-sdk/docs/PADateParameters.md | 14 + auto-generated-sdk/docs/PAIdentifier.md | 12 + auto-generated-sdk/docs/PAPricingSource.md | 13 + .../docs/PAPricingSourceRoot.md | 12 + auto-generated-sdk/docs/PaDoc.md | 11 + auto-generated-sdk/docs/PricingSourcesApi.md | 107 ++ auto-generated-sdk/docs/Section.md | 14 + .../docs/StrategyDocumentsApi.md | 93 ++ .../docs/TemplateContentTypes.md | 13 + .../docs/TemplatedPAComponent.md | 18 + .../docs/TemplatedPAComponentParameters.md | 14 + .../TemplatedPAComponentParametersRoot.md | 12 + .../docs/TemplatedPAComponentPostSummary.md | 15 + .../TemplatedPAComponentPostSummaryRoot.md | 12 + .../docs/TemplatedPAComponentRoot.md | 12 + .../docs/TemplatedPAComponentSummary.md | 14 + .../docs/TemplatedPAComponentSummaryRoot.md | 12 + .../TemplatedPAComponentUpdateParameters.md | 13 + ...emplatedPAComponentUpdateParametersRoot.md | 12 + .../docs/TemplatedPAComponentsApi.md | 584 ++++++++ auto-generated-sdk/docs/UnlinkedPATemplate.md | 26 + .../docs/UnlinkedPATemplateCategoryAndType.md | 12 + ...nlinkedPATemplateCategoryAndTypeDetails.md | 16 + ...kedPATemplateCategoryAndTypeDetailsRoot.md | 12 + .../UnlinkedPATemplateCategoryAndTypeRoot.md | 12 + .../docs/UnlinkedPATemplateColumnDetails.md | 13 + .../docs/UnlinkedPATemplateGroupDetails.md | 13 + .../docs/UnlinkedPATemplateParameters.md | 22 + .../docs/UnlinkedPATemplateParametersRoot.md | 12 + .../docs/UnlinkedPATemplatePostSummary.md | 14 + .../docs/UnlinkedPATemplatePostSummaryRoot.md | 12 + .../docs/UnlinkedPATemplateRoot.md | 12 + .../docs/UnlinkedPATemplateSummary.md | 13 + .../docs/UnlinkedPATemplateSummaryRoot.md | 12 + .../UnlinkedPATemplateUpdateParameters.md | 20 + .../UnlinkedPATemplateUpdateParametersRoot.md | 12 + .../docs/UnlinkedPATemplatesApi.md | 782 ++++++++++ .../engines/api/column_statistics_api.py | 146 ++ .../analyticsapi/engines/api/columns_api.py | 286 ++++ .../engines/api/components_api.py | 241 +++ .../engines/api/configurations_api.py | 121 ++ .../fds/analyticsapi/engines/api/dates_api.py | 146 ++ .../analyticsapi/engines/api/documents_api.py | 120 ++ .../engines/api/fpo_optimizer_api.py | 795 ++++++++++ .../engines/api/frequencies_api.py | 108 ++ .../analyticsapi/engines/api/groups_api.py | 255 ++++ .../engines/api/linked_pa_templates_api.py | 661 +++++++++ .../engines/api/pa_calculations_api.py | 1316 +++++++++++++++++ .../engines/api/pricing_sources_api.py | 165 +++ .../engines/api/strategy_documents_api.py | 120 ++ .../api/templated_pa_components_api.py | 655 ++++++++ .../engines/api/unlinked_pa_templates_api.py | 885 +++++++++++ .../fds/analyticsapi/engines/apis/__init__.py | 9 + .../fds/analyticsapi/engines/model/column.py | 176 +++ .../analyticsapi/engines/model/column_root.py | 178 +++ .../engines/model/column_statistic.py | 167 +++ .../engines/model/column_statistic_root.py | 178 +++ .../engines/model/column_summary.py | 173 +++ .../engines/model/column_summary_root.py | 178 +++ .../analyticsapi/engines/model/fpo_account.py | 183 +++ .../engines/model/fpo_objective.py | 174 +++ .../model/fpo_optimization_parameters.py | 191 +++ .../model/fpo_optimization_parameters_root.py | 175 +++ .../engines/model/fpo_optimizer_strategy.py | 178 +++ .../model/fpo_optimizer_strategy_overrides.py | 185 +++ .../fds/analyticsapi/engines/model/group.py | 173 +++ .../analyticsapi/engines/model/group_root.py | 178 +++ .../engines/model/linked_pa_template.py | 190 +++ .../model/linked_pa_template_parameters.py | 185 +++ .../linked_pa_template_parameters_root.py | 178 +++ .../model/linked_pa_template_post_summary.py | 176 +++ .../linked_pa_template_post_summary_root.py | 178 +++ .../engines/model/linked_pa_template_root.py | 178 +++ .../model/linked_pa_template_summary.py | 173 +++ .../model/linked_pa_template_summary_root.py | 178 +++ .../linked_pa_template_update_parameters.py | 178 +++ ...nked_pa_template_update_parameters_root.py | 178 +++ .../analyticsapi/engines/model/metadata.py | 187 +++ .../engines/model/pa_calculation_column.py | 170 +++ .../model/pa_calculation_data_sources.py | 178 +++ .../engines/model/pa_calculation_group.py | 170 +++ .../model/pa_calculation_parameters.py | 207 +++ .../model/pa_calculation_parameters_root.py | 177 +++ .../model/pa_calculation_pricing_source.py | 167 +++ .../engines/model/pa_commentary.py | 178 +++ .../pa_commentary_configuration_summary.py | 170 +++ ...a_commentary_configuration_summary_root.py | 178 +++ .../engines/model/pa_commentary_date.py | 170 +++ .../engines/model/pa_commentary_get_status.py | 177 +++ .../model/pa_commentary_get_status_root.py | 178 +++ .../engines/model/pa_commentary_parameters.py | 167 +++ .../model/pa_commentary_parameters_root.py | 178 +++ .../engines/model/pa_commentary_root.py | 178 +++ .../engines/model/pa_commentary_status.py | 180 +++ .../model/pa_commentary_status_root.py | 178 +++ .../engines/model/pa_component.py | 198 +++ .../engines/model/pa_component_data.py | 201 +++ .../engines/model/pa_component_root.py | 178 +++ .../engines/model/pa_date_parameters.py | 177 +++ .../fds/analyticsapi/engines/model/pa_doc.py | 170 +++ .../engines/model/pa_identifier.py | 173 +++ .../engines/model/pa_pricing_source.py | 173 +++ .../engines/model/pa_pricing_source_root.py | 178 +++ .../fds/analyticsapi/engines/model/section.py | 181 +++ .../engines/model/template_content_types.py | 173 +++ .../engines/model/templated_pa_component.py | 193 +++ .../templated_pa_component_parameters.py | 185 +++ .../templated_pa_component_parameters_root.py | 178 +++ .../templated_pa_component_post_summary.py | 179 +++ ...emplated_pa_component_post_summary_root.py | 178 +++ .../model/templated_pa_component_root.py | 178 +++ .../model/templated_pa_component_summary.py | 176 +++ .../templated_pa_component_summary_root.py | 178 +++ ...emplated_pa_component_update_parameters.py | 178 +++ ...ted_pa_component_update_parameters_root.py | 178 +++ .../engines/model/unlinked_pa_template.py | 227 +++ .../unlinked_pa_template_category_and_type.py | 170 +++ ...d_pa_template_category_and_type_details.py | 189 +++ ...template_category_and_type_details_root.py | 178 +++ ...nked_pa_template_category_and_type_root.py | 178 +++ .../unlinked_pa_template_column_details.py | 173 +++ .../unlinked_pa_template_group_details.py | 173 +++ .../model/unlinked_pa_template_parameters.py | 219 +++ .../unlinked_pa_template_parameters_root.py | 178 +++ .../unlinked_pa_template_post_summary.py | 176 +++ .../unlinked_pa_template_post_summary_root.py | 178 +++ .../model/unlinked_pa_template_root.py | 178 +++ .../model/unlinked_pa_template_summary.py | 173 +++ .../unlinked_pa_template_summary_root.py | 178 +++ .../unlinked_pa_template_update_parameters.py | 209 +++ ...nked_pa_template_update_parameters_root.py | 178 +++ .../analyticsapi/engines/models/__init__.py | 78 + 190 files changed, 26399 insertions(+) create mode 100644 auto-generated-sdk/docs/Column.md create mode 100644 auto-generated-sdk/docs/ColumnRoot.md create mode 100644 auto-generated-sdk/docs/ColumnStatistic.md create mode 100644 auto-generated-sdk/docs/ColumnStatisticRoot.md create mode 100644 auto-generated-sdk/docs/ColumnStatisticsApi.md create mode 100644 auto-generated-sdk/docs/ColumnSummary.md create mode 100644 auto-generated-sdk/docs/ColumnSummaryRoot.md create mode 100644 auto-generated-sdk/docs/ColumnsApi.md create mode 100644 auto-generated-sdk/docs/FPOAccount.md create mode 100644 auto-generated-sdk/docs/FPOObjective.md create mode 100644 auto-generated-sdk/docs/FPOOptimizationParameters.md create mode 100644 auto-generated-sdk/docs/FPOOptimizationParametersRoot.md create mode 100644 auto-generated-sdk/docs/FPOOptimizerApi.md create mode 100644 auto-generated-sdk/docs/FPOOptimizerStrategy.md create mode 100644 auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md create mode 100644 auto-generated-sdk/docs/Group.md create mode 100644 auto-generated-sdk/docs/GroupRoot.md create mode 100644 auto-generated-sdk/docs/GroupsApi.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplate.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateParameters.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplatePostSummary.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateSummary.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md create mode 100644 auto-generated-sdk/docs/LinkedPATemplatesApi.md create mode 100644 auto-generated-sdk/docs/Metadata.md create mode 100644 auto-generated-sdk/docs/PACalculationColumn.md create mode 100644 auto-generated-sdk/docs/PACalculationDataSources.md create mode 100644 auto-generated-sdk/docs/PACalculationGroup.md create mode 100644 auto-generated-sdk/docs/PACalculationParameters.md create mode 100644 auto-generated-sdk/docs/PACalculationParametersRoot.md create mode 100644 auto-generated-sdk/docs/PACalculationPricingSource.md create mode 100644 auto-generated-sdk/docs/PACalculationsApi.md create mode 100644 auto-generated-sdk/docs/PACommentary.md create mode 100644 auto-generated-sdk/docs/PACommentaryConfigurationSummary.md create mode 100644 auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md create mode 100644 auto-generated-sdk/docs/PACommentaryDate.md create mode 100644 auto-generated-sdk/docs/PACommentaryGetStatus.md create mode 100644 auto-generated-sdk/docs/PACommentaryGetStatusRoot.md create mode 100644 auto-generated-sdk/docs/PACommentaryParameters.md create mode 100644 auto-generated-sdk/docs/PACommentaryParametersRoot.md create mode 100644 auto-generated-sdk/docs/PACommentaryRoot.md create mode 100644 auto-generated-sdk/docs/PACommentaryStatus.md create mode 100644 auto-generated-sdk/docs/PACommentaryStatusRoot.md create mode 100644 auto-generated-sdk/docs/PAComponent.md create mode 100644 auto-generated-sdk/docs/PAComponentData.md create mode 100644 auto-generated-sdk/docs/PAComponentRoot.md create mode 100644 auto-generated-sdk/docs/PADateParameters.md create mode 100644 auto-generated-sdk/docs/PAIdentifier.md create mode 100644 auto-generated-sdk/docs/PAPricingSource.md create mode 100644 auto-generated-sdk/docs/PAPricingSourceRoot.md create mode 100644 auto-generated-sdk/docs/PaDoc.md create mode 100644 auto-generated-sdk/docs/PricingSourcesApi.md create mode 100644 auto-generated-sdk/docs/Section.md create mode 100644 auto-generated-sdk/docs/TemplateContentTypes.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponent.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentParameters.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentSummary.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md create mode 100644 auto-generated-sdk/docs/TemplatedPAComponentsApi.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplate.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateParameters.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateSummary.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md create mode 100644 auto-generated-sdk/docs/UnlinkedPATemplatesApi.md create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_summary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/column_summary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_account.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_objective.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/group.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/group_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/metadata.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_column.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_data_sources.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_group.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_pricing_source.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_date.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_component.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_data.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_date_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_doc.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_identifier.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/section.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/template_content_types.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index c2aab057..c6095b3f 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -35,6 +35,14 @@ docs/CalculationUnitStatusMeta.md docs/CalculationsSummary.md docs/CalculationsSummaryRoot.md docs/ClientErrorResponse.md +docs/Column.md +docs/ColumnRoot.md +docs/ColumnStatistic.md +docs/ColumnStatisticRoot.md +docs/ColumnStatisticsApi.md +docs/ColumnSummary.md +docs/ColumnSummaryRoot.md +docs/ColumnsApi.md docs/ComponentSummary.md docs/ComponentSummaryRoot.md docs/ComponentsApi.md @@ -85,9 +93,31 @@ docs/FIServicerAdvances.md docs/FIServicerAdvancesForSecurities.md docs/FIStructuredProductsForJobSettings.md docs/FIStructuredProductsForSecurities.md +docs/FPOAccount.md +docs/FPOObjective.md +docs/FPOOptimizationParameters.md +docs/FPOOptimizationParametersRoot.md +docs/FPOOptimizerApi.md +docs/FPOOptimizerStrategy.md +docs/FPOOptimizerStrategyOverrides.md docs/FrequenciesApi.md docs/Frequency.md docs/FrequencyRoot.md +docs/Group.md +docs/GroupRoot.md +docs/GroupsApi.md +docs/LinkedPATemplate.md +docs/LinkedPATemplateParameters.md +docs/LinkedPATemplateParametersRoot.md +docs/LinkedPATemplatePostSummary.md +docs/LinkedPATemplatePostSummaryRoot.md +docs/LinkedPATemplateRoot.md +docs/LinkedPATemplateSummary.md +docs/LinkedPATemplateSummaryRoot.md +docs/LinkedPATemplateUpdateParameters.md +docs/LinkedPATemplateUpdateParametersRoot.md +docs/LinkedPATemplatesApi.md +docs/Metadata.md docs/NPOOptimizationParameters.md docs/NPOOptimizationParametersRoot.md docs/NPOOptimizerApi.md @@ -101,8 +131,35 @@ docs/OptimizerAccountOverrides.md docs/OptimizerOptimalHoldings.md docs/OptimizerOutputTypes.md docs/OptimizerTradesList.md +docs/PACalculationColumn.md +docs/PACalculationDataSources.md +docs/PACalculationGroup.md +docs/PACalculationParameters.md +docs/PACalculationParametersRoot.md +docs/PACalculationPricingSource.md +docs/PACalculationsApi.md +docs/PACommentary.md +docs/PACommentaryConfigurationSummary.md +docs/PACommentaryConfigurationSummaryRoot.md +docs/PACommentaryDate.md +docs/PACommentaryGetStatus.md +docs/PACommentaryGetStatusRoot.md +docs/PACommentaryParameters.md +docs/PACommentaryParametersRoot.md +docs/PACommentaryRoot.md +docs/PACommentaryStatus.md +docs/PACommentaryStatusRoot.md +docs/PAComponent.md +docs/PAComponentData.md +docs/PAComponentRoot.md +docs/PADateParameters.md +docs/PAIdentifier.md +docs/PAPricingSource.md +docs/PAPricingSourceRoot.md +docs/PaDoc.md docs/PaginationInfo.md docs/PaginationMeta.md +docs/PricingSourcesApi.md docs/PubCalculationParameters.md docs/PubCalculationParametersRoot.md docs/PubCalculationsApi.md @@ -136,7 +193,37 @@ docs/SPARComponent.md docs/SPARComponentRoot.md docs/SPARDateParameters.md docs/SPARIdentifier.md +docs/Section.md docs/StrategyDocumentsApi.md +docs/TemplateContentTypes.md +docs/TemplatedPAComponent.md +docs/TemplatedPAComponentParameters.md +docs/TemplatedPAComponentParametersRoot.md +docs/TemplatedPAComponentPostSummary.md +docs/TemplatedPAComponentPostSummaryRoot.md +docs/TemplatedPAComponentRoot.md +docs/TemplatedPAComponentSummary.md +docs/TemplatedPAComponentSummaryRoot.md +docs/TemplatedPAComponentUpdateParameters.md +docs/TemplatedPAComponentUpdateParametersRoot.md +docs/TemplatedPAComponentsApi.md +docs/UnlinkedPATemplate.md +docs/UnlinkedPATemplateCategoryAndType.md +docs/UnlinkedPATemplateCategoryAndTypeDetails.md +docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md +docs/UnlinkedPATemplateCategoryAndTypeRoot.md +docs/UnlinkedPATemplateColumnDetails.md +docs/UnlinkedPATemplateGroupDetails.md +docs/UnlinkedPATemplateParameters.md +docs/UnlinkedPATemplateParametersRoot.md +docs/UnlinkedPATemplatePostSummary.md +docs/UnlinkedPATemplatePostSummaryRoot.md +docs/UnlinkedPATemplateRoot.md +docs/UnlinkedPATemplateSummary.md +docs/UnlinkedPATemplateSummaryRoot.md +docs/UnlinkedPATemplateUpdateParameters.md +docs/UnlinkedPATemplateUpdateParametersRoot.md +docs/UnlinkedPATemplatesApi.md docs/VaultAttributionLoaderApi.md docs/VaultAttributionLoaderResponse.md docs/VaultAttributionLoaderResponseRoot.md @@ -160,6 +247,8 @@ fds/analyticsapi/engines/api/afi_optimizer_api.py fds/analyticsapi/engines/api/axp_optimizer_api.py fds/analyticsapi/engines/api/benchmarks_api.py fds/analyticsapi/engines/api/bpm_optimizer_api.py +fds/analyticsapi/engines/api/column_statistics_api.py +fds/analyticsapi/engines/api/columns_api.py fds/analyticsapi/engines/api/components_api.py fds/analyticsapi/engines/api/configurations_api.py fds/analyticsapi/engines/api/currencies_api.py @@ -168,12 +257,19 @@ fds/analyticsapi/engines/api/discount_curves_api.py fds/analyticsapi/engines/api/documents_api.py fds/analyticsapi/engines/api/fi_calculations_api.py fds/analyticsapi/engines/api/fiab_calculations_api.py +fds/analyticsapi/engines/api/fpo_optimizer_api.py fds/analyticsapi/engines/api/frequencies_api.py +fds/analyticsapi/engines/api/groups_api.py +fds/analyticsapi/engines/api/linked_pa_templates_api.py fds/analyticsapi/engines/api/npo_optimizer_api.py +fds/analyticsapi/engines/api/pa_calculations_api.py +fds/analyticsapi/engines/api/pricing_sources_api.py fds/analyticsapi/engines/api/pub_calculations_api.py fds/analyticsapi/engines/api/quant_calculations_api.py fds/analyticsapi/engines/api/spar_calculations_api.py fds/analyticsapi/engines/api/strategy_documents_api.py +fds/analyticsapi/engines/api/templated_pa_components_api.py +fds/analyticsapi/engines/api/unlinked_pa_templates_api.py fds/analyticsapi/engines/api/vault_attribution_loader_api.py fds/analyticsapi/engines/api/vault_calculations_api.py fds/analyticsapi/engines/api_client.py @@ -208,6 +304,12 @@ fds/analyticsapi/engines/model/calculation_unit_status_meta.py fds/analyticsapi/engines/model/calculations_summary.py fds/analyticsapi/engines/model/calculations_summary_root.py fds/analyticsapi/engines/model/client_error_response.py +fds/analyticsapi/engines/model/column.py +fds/analyticsapi/engines/model/column_root.py +fds/analyticsapi/engines/model/column_statistic.py +fds/analyticsapi/engines/model/column_statistic_root.py +fds/analyticsapi/engines/model/column_summary.py +fds/analyticsapi/engines/model/column_summary_root.py fds/analyticsapi/engines/model/component_summary.py fds/analyticsapi/engines/model/component_summary_root.py fds/analyticsapi/engines/model/configuration_account.py @@ -250,8 +352,27 @@ fds/analyticsapi/engines/model/fiab_calculation_status.py fds/analyticsapi/engines/model/fiab_calculation_status_summary.py fds/analyticsapi/engines/model/fiab_date_parameters.py fds/analyticsapi/engines/model/fiab_identifier.py +fds/analyticsapi/engines/model/fpo_account.py +fds/analyticsapi/engines/model/fpo_objective.py +fds/analyticsapi/engines/model/fpo_optimization_parameters.py +fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py +fds/analyticsapi/engines/model/fpo_optimizer_strategy.py +fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py fds/analyticsapi/engines/model/frequency.py fds/analyticsapi/engines/model/frequency_root.py +fds/analyticsapi/engines/model/group.py +fds/analyticsapi/engines/model/group_root.py +fds/analyticsapi/engines/model/linked_pa_template.py +fds/analyticsapi/engines/model/linked_pa_template_parameters.py +fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py +fds/analyticsapi/engines/model/linked_pa_template_post_summary.py +fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py +fds/analyticsapi/engines/model/linked_pa_template_root.py +fds/analyticsapi/engines/model/linked_pa_template_summary.py +fds/analyticsapi/engines/model/linked_pa_template_summary_root.py +fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py +fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py +fds/analyticsapi/engines/model/metadata.py fds/analyticsapi/engines/model/npo_optimization_parameters.py fds/analyticsapi/engines/model/npo_optimization_parameters_root.py fds/analyticsapi/engines/model/npo_optimizer_strategy.py @@ -264,6 +385,31 @@ fds/analyticsapi/engines/model/optimizer_account_overrides.py fds/analyticsapi/engines/model/optimizer_optimal_holdings.py fds/analyticsapi/engines/model/optimizer_output_types.py fds/analyticsapi/engines/model/optimizer_trades_list.py +fds/analyticsapi/engines/model/pa_calculation_column.py +fds/analyticsapi/engines/model/pa_calculation_data_sources.py +fds/analyticsapi/engines/model/pa_calculation_group.py +fds/analyticsapi/engines/model/pa_calculation_parameters.py +fds/analyticsapi/engines/model/pa_calculation_parameters_root.py +fds/analyticsapi/engines/model/pa_calculation_pricing_source.py +fds/analyticsapi/engines/model/pa_commentary.py +fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py +fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py +fds/analyticsapi/engines/model/pa_commentary_date.py +fds/analyticsapi/engines/model/pa_commentary_get_status.py +fds/analyticsapi/engines/model/pa_commentary_get_status_root.py +fds/analyticsapi/engines/model/pa_commentary_parameters.py +fds/analyticsapi/engines/model/pa_commentary_parameters_root.py +fds/analyticsapi/engines/model/pa_commentary_root.py +fds/analyticsapi/engines/model/pa_commentary_status.py +fds/analyticsapi/engines/model/pa_commentary_status_root.py +fds/analyticsapi/engines/model/pa_component.py +fds/analyticsapi/engines/model/pa_component_data.py +fds/analyticsapi/engines/model/pa_component_root.py +fds/analyticsapi/engines/model/pa_date_parameters.py +fds/analyticsapi/engines/model/pa_doc.py +fds/analyticsapi/engines/model/pa_identifier.py +fds/analyticsapi/engines/model/pa_pricing_source.py +fds/analyticsapi/engines/model/pa_pricing_source_root.py fds/analyticsapi/engines/model/pagination_info.py fds/analyticsapi/engines/model/pagination_meta.py fds/analyticsapi/engines/model/pub_calculation_parameters.py @@ -286,6 +432,7 @@ fds/analyticsapi/engines/model/quant_universal_screen_parameter.py fds/analyticsapi/engines/model/quant_universal_screen_universe.py fds/analyticsapi/engines/model/quant_universe.py fds/analyticsapi/engines/model/return_type.py +fds/analyticsapi/engines/model/section.py fds/analyticsapi/engines/model/spar_accounts.py fds/analyticsapi/engines/model/spar_accounts_root.py fds/analyticsapi/engines/model/spar_benchmark.py @@ -296,6 +443,33 @@ fds/analyticsapi/engines/model/spar_component.py fds/analyticsapi/engines/model/spar_component_root.py fds/analyticsapi/engines/model/spar_date_parameters.py fds/analyticsapi/engines/model/spar_identifier.py +fds/analyticsapi/engines/model/template_content_types.py +fds/analyticsapi/engines/model/templated_pa_component.py +fds/analyticsapi/engines/model/templated_pa_component_parameters.py +fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py +fds/analyticsapi/engines/model/templated_pa_component_post_summary.py +fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py +fds/analyticsapi/engines/model/templated_pa_component_root.py +fds/analyticsapi/engines/model/templated_pa_component_summary.py +fds/analyticsapi/engines/model/templated_pa_component_summary_root.py +fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py +fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py +fds/analyticsapi/engines/model/unlinked_pa_template.py +fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py +fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py +fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py +fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py +fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py +fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py +fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py +fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py +fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py +fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py +fds/analyticsapi/engines/model/unlinked_pa_template_root.py +fds/analyticsapi/engines/model/unlinked_pa_template_summary.py +fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py +fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py +fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py fds/analyticsapi/engines/model/vault_attribution_loader_response.py fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py fds/analyticsapi/engines/model/vault_calculation_parameters.py diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index d6157ee0..ef35a04f 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -118,15 +118,23 @@ Class | Method | HTTP request | Description *BPMOptimizerApi* | [**post_and_optimize**](docs/BPMOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/bpm/v3/optimizations | Create and Run BPM optimization *BPMOptimizerApi* | [**put_and_optimize**](docs/BPMOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/bpm/v3/optimizations/{id} | Create or Update BPM optimization and run it. *BenchmarksApi* | [**get_spar_benchmark_by_id**](docs/BenchmarksApi.md#get_spar_benchmark_by_id) | **GET** /analytics/engines/spar/v3/benchmarks | Get SPAR benchmark details +*ColumnStatisticsApi* | [**get_pa_column_statistics**](docs/ColumnStatisticsApi.md#get_pa_column_statistics) | **GET** /analytics/engines/pa/v3/columnstatistics | Get PA column statistics +*ColumnsApi* | [**get_pa_column_by_id**](docs/ColumnsApi.md#get_pa_column_by_id) | **GET** /analytics/engines/pa/v3/columns/{id} | Get PA column settings +*ColumnsApi* | [**get_pa_columns**](docs/ColumnsApi.md#get_pa_columns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns +*ComponentsApi* | [**get_pa_component_by_id**](docs/ComponentsApi.md#get_pa_component_by_id) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id +*ComponentsApi* | [**get_pa_components**](docs/ComponentsApi.md#get_pa_components) | **GET** /analytics/engines/pa/v3/components | Get PA components *ComponentsApi* | [**get_spar_component_by_id**](docs/ComponentsApi.md#get_spar_component_by_id) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id *ComponentsApi* | [**get_spar_components**](docs/ComponentsApi.md#get_spar_components) | **GET** /analytics/engines/spar/v3/components | Get SPAR components *ComponentsApi* | [**get_vault_component_by_id**](docs/ComponentsApi.md#get_vault_component_by_id) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id *ComponentsApi* | [**get_vault_components**](docs/ComponentsApi.md#get_vault_components) | **GET** /analytics/engines/vault/v3/components | Get Vault components +*ConfigurationsApi* | [**get_pa_commentary_configurations**](docs/ConfigurationsApi.md#get_pa_commentary_configurations) | **GET** /analytics/engines/pa/v3/commentary/configurations | Get PA commentary configurations in a directory *ConfigurationsApi* | [**get_vault_configuration_by_id**](docs/ConfigurationsApi.md#get_vault_configuration_by_id) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id *ConfigurationsApi* | [**get_vault_configurations**](docs/ConfigurationsApi.md#get_vault_configurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations *CurrenciesApi* | [**get_currencies**](docs/CurrenciesApi.md#get_currencies) | **GET** /analytics/lookups/v3/currencies | Get currencies +*DatesApi* | [**convert_pa_dates_to_absolute_format**](docs/DatesApi.md#convert_pa_dates_to_absolute_format) | **GET** /analytics/engines/pa/v3/dates | Convert PA dates to absolute format *DatesApi* | [**convert_vault_dates_to_absolute_format**](docs/DatesApi.md#convert_vault_dates_to_absolute_format) | **GET** /analytics/engines/vault/v3/dates | Convert Vault dates to absolute format *DiscountCurvesApi* | [**get_all_fi_discount_curves**](docs/DiscountCurvesApi.md#get_all_fi_discount_curves) | **GET** /analytics/engines/fi/v3/discount-curves | Get Discount Curves +*DocumentsApi* | [**get_pa3_documents**](docs/DocumentsApi.md#get_pa3_documents) | **GET** /analytics/engines/pa/v3/documents/{path} | Get PA3 documents and sub-directories in a directory *DocumentsApi* | [**get_pub_documents**](docs/DocumentsApi.md#get_pub_documents) | **GET** /analytics/engines/pub/v3/documents/{path} | Gets Publisher documents and sub-directories in a directory *DocumentsApi* | [**get_spar3_documents**](docs/DocumentsApi.md#get_spar3_documents) | **GET** /analytics/engines/spar/v3/documents/{path} | Gets SPAR3 documents and sub-directories in a directory *DocumentsApi* | [**get_vault_documents**](docs/DocumentsApi.md#get_vault_documents) | **GET** /analytics/engines/vault/v3/documents/{path} | Get Vault documents and sub-directories in a directory @@ -139,14 +147,39 @@ Class | Method | HTTP request | Description *FICalculationsApi* | [**get_calculation_status_by_id**](docs/FICalculationsApi.md#get_calculation_status_by_id) | **GET** /analytics/engines/fi/v3/calculations/{id}/status | Get FI calculation status by id *FICalculationsApi* | [**post_and_calculate**](docs/FICalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/fi/v3/calculations | Create and Run FI calculation *FICalculationsApi* | [**put_and_calculate**](docs/FICalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/fi/v3/calculations/{id} | Create or Update FI calculation and run it. +*FPOOptimizerApi* | [**cancel_optimization_by_id**](docs/FPOOptimizerApi.md#cancel_optimization_by_id) | **DELETE** /analytics/engines/fpo/v3/optimizations/{id} | Cancel FPO optimization by id +*FPOOptimizerApi* | [**get_optimization_parameters**](docs/FPOOptimizerApi.md#get_optimization_parameters) | **GET** /analytics/engines/fpo/v3/optimizations/{id} | Get FPO optimization parameters by id +*FPOOptimizerApi* | [**get_optimization_result**](docs/FPOOptimizerApi.md#get_optimization_result) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/result | Get FPO optimization result by id +*FPOOptimizerApi* | [**get_optimization_status_by_id**](docs/FPOOptimizerApi.md#get_optimization_status_by_id) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/status | Get FPO optimization status by id +*FPOOptimizerApi* | [**post_and_optimize**](docs/FPOOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/fpo/v3/optimizations | Create and Run FPO optimization +*FPOOptimizerApi* | [**put_and_optimize**](docs/FPOOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/fpo/v3/optimizations/{id} | Create or Update FPO optimization and run it. +*FrequenciesApi* | [**get_pa_frequencies**](docs/FrequenciesApi.md#get_pa_frequencies) | **GET** /analytics/engines/pa/v3/frequencies | Get PA frequencies *FrequenciesApi* | [**get_spar_frequencies**](docs/FrequenciesApi.md#get_spar_frequencies) | **GET** /analytics/engines/spar/v3/frequencies | Get SPAR frequencies *FrequenciesApi* | [**get_vault_frequencies**](docs/FrequenciesApi.md#get_vault_frequencies) | **GET** /analytics/engines/vault/v3/frequencies | Get Vault frequencies +*GroupsApi* | [**get_pa_grouping_frequencies**](docs/GroupsApi.md#get_pa_grouping_frequencies) | **GET** /analytics/engines/pa/v3/grouping-frequencies | Get PA grouping frequencies +*GroupsApi* | [**get_pa_groups**](docs/GroupsApi.md#get_pa_groups) | **GET** /analytics/engines/pa/v3/groups | Get PA groups +*LinkedPATemplatesApi* | [**create_linked_pa_templates**](docs/LinkedPATemplatesApi.md#create_linked_pa_templates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template +*LinkedPATemplatesApi* | [**delete_linked_pa_templates**](docs/LinkedPATemplatesApi.md#delete_linked_pa_templates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. +*LinkedPATemplatesApi* | [**get_linked_pa_templates**](docs/LinkedPATemplatesApi.md#get_linked_pa_templates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates +*LinkedPATemplatesApi* | [**get_linked_pa_templates_by_id**](docs/LinkedPATemplatesApi.md#get_linked_pa_templates_by_id) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id +*LinkedPATemplatesApi* | [**update_linked_pa_templates**](docs/LinkedPATemplatesApi.md#update_linked_pa_templates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template *NPOOptimizerApi* | [**cancel_optimization_by_id**](docs/NPOOptimizerApi.md#cancel_optimization_by_id) | **DELETE** /analytics/engines/npo/v3/optimizations/{id} | Cancel NPO optimization by id *NPOOptimizerApi* | [**get_optimization_parameters**](docs/NPOOptimizerApi.md#get_optimization_parameters) | **GET** /analytics/engines/npo/v3/optimizations/{id} | Get NPO optimization parameters by id *NPOOptimizerApi* | [**get_optimization_result**](docs/NPOOptimizerApi.md#get_optimization_result) | **GET** /analytics/engines/npo/v3/optimizations/{id}/result | Get NPO optimization result by id *NPOOptimizerApi* | [**get_optimization_status_by_id**](docs/NPOOptimizerApi.md#get_optimization_status_by_id) | **GET** /analytics/engines/npo/v3/optimizations/{id}/status | Get NPO optimization status by id *NPOOptimizerApi* | [**post_and_optimize**](docs/NPOOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/npo/v3/optimizations | Create and Run NPO optimization *NPOOptimizerApi* | [**put_and_optimize**](docs/NPOOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/npo/v3/optimizations/{id} | Create or Update NPO optimization and run it. +*PACalculationsApi* | [**cancel_calculation_by_id**](docs/PACalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id +*PACalculationsApi* | [**generate_pa_portfolio_commentary**](docs/PACalculationsApi.md#generate_pa_portfolio_commentary) | **POST** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary | Generate PA portfolio commentary by calculation and unit id. +*PACalculationsApi* | [**get_all_calculations**](docs/PACalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations +*PACalculationsApi* | [**get_calculation_parameters**](docs/PACalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id +*PACalculationsApi* | [**get_calculation_status_by_id**](docs/PACalculationsApi.md#get_calculation_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id +*PACalculationsApi* | [**get_calculation_unit_result_by_id**](docs/PACalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id +*PACalculationsApi* | [**get_pa_portfolio_commentary_result_by_id**](docs/PACalculationsApi.md#get_pa_portfolio_commentary_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result | Get PA Portfolio commentary result by calculation and unit id. +*PACalculationsApi* | [**get_pa_portfolio_commentary_status_by_id**](docs/PACalculationsApi.md#get_pa_portfolio_commentary_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status | Get PA portfolio commentary status by calculation and unit id. +*PACalculationsApi* | [**post_and_calculate**](docs/PACalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation +*PACalculationsApi* | [**put_and_calculate**](docs/PACalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. +*PricingSourcesApi* | [**get_pa_pricing_sources**](docs/PricingSourcesApi.md#get_pa_pricing_sources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources *PubCalculationsApi* | [**cancel_calculation_by_id**](docs/PubCalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/pub/v3/calculations/{id} | Cancel Pub calculation by id *PubCalculationsApi* | [**get_all_calculations**](docs/PubCalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/pub/v3/calculations | Get all calculations *PubCalculationsApi* | [**get_calculation_parameters**](docs/PubCalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/pub/v3/calculations/{id} | Get Pub calculation parameters by id @@ -172,7 +205,20 @@ Class | Method | HTTP request | Description *StrategyDocumentsApi* | [**get_axioma_equity_strategy_documents**](docs/StrategyDocumentsApi.md#get_axioma_equity_strategy_documents) | **GET** /analytics/engines/axp/v3/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**get_axioma_fi_strategy_documents**](docs/StrategyDocumentsApi.md#get_axioma_fi_strategy_documents) | **GET** /analytics/engines/afi/v3/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**get_barra_strategy_documents**](docs/StrategyDocumentsApi.md#get_barra_strategy_documents) | **GET** /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory +*StrategyDocumentsApi* | [**get_fpo_strategy_documents**](docs/StrategyDocumentsApi.md#get_fpo_strategy_documents) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory *StrategyDocumentsApi* | [**get_northfield_strategy_documents**](docs/StrategyDocumentsApi.md#get_northfield_strategy_documents) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory +*TemplatedPAComponentsApi* | [**create_templated_pa_components**](docs/TemplatedPAComponentsApi.md#create_templated_pa_components) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component +*TemplatedPAComponentsApi* | [**delete_templated_pa_components**](docs/TemplatedPAComponentsApi.md#delete_templated_pa_components) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component +*TemplatedPAComponentsApi* | [**get_templated_pa_component_by_id**](docs/TemplatedPAComponentsApi.md#get_templated_pa_component_by_id) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id +*TemplatedPAComponentsApi* | [**get_templated_pa_components_in_path**](docs/TemplatedPAComponentsApi.md#get_templated_pa_components_in_path) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path +*TemplatedPAComponentsApi* | [**update_templated_pa_components**](docs/TemplatedPAComponentsApi.md#update_templated_pa_components) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component +*UnlinkedPATemplatesApi* | [**create_unlinked_pa_templates**](docs/UnlinkedPATemplatesApi.md#create_unlinked_pa_templates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template +*UnlinkedPATemplatesApi* | [**delete_unlinked_pa_templates**](docs/UnlinkedPATemplatesApi.md#delete_unlinked_pa_templates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template +*UnlinkedPATemplatesApi* | [**get_default_unlinked_pa_template_types**](docs/UnlinkedPATemplatesApi.md#get_default_unlinked_pa_template_types) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. +*UnlinkedPATemplatesApi* | [**get_details_type**](docs/UnlinkedPATemplatesApi.md#get_details_type) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. +*UnlinkedPATemplatesApi* | [**get_unlinked_pa_templates**](docs/UnlinkedPATemplatesApi.md#get_unlinked_pa_templates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates +*UnlinkedPATemplatesApi* | [**get_unlinked_pa_templates_by_id**](docs/UnlinkedPATemplatesApi.md#get_unlinked_pa_templates_by_id) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id +*UnlinkedPATemplatesApi* | [**update_unlinked_pa_templates**](docs/UnlinkedPATemplatesApi.md#update_unlinked_pa_templates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template *VaultCalculationsApi* | [**cancel_calculation_by_id**](docs/VaultCalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/vault/v3/calculations/{id} | Cancel Vault calculation by id *VaultCalculationsApi* | [**get_all_calculations**](docs/VaultCalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/vault/v3/calculations | Get all calculations *VaultCalculationsApi* | [**get_calculation_parameters**](docs/VaultCalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/vault/v3/calculations/{id} | Get Vault calculation parameters by id @@ -212,6 +258,12 @@ Class | Method | HTTP request | Description - [CalculationsSummary](docs/CalculationsSummary.md) - [CalculationsSummaryRoot](docs/CalculationsSummaryRoot.md) - [ClientErrorResponse](docs/ClientErrorResponse.md) + - [Column](docs/Column.md) + - [ColumnRoot](docs/ColumnRoot.md) + - [ColumnStatistic](docs/ColumnStatistic.md) + - [ColumnStatisticRoot](docs/ColumnStatisticRoot.md) + - [ColumnSummary](docs/ColumnSummary.md) + - [ColumnSummaryRoot](docs/ColumnSummaryRoot.md) - [ComponentSummary](docs/ComponentSummary.md) - [ComponentSummaryRoot](docs/ComponentSummaryRoot.md) - [ConfigurationAccount](docs/ConfigurationAccount.md) @@ -254,8 +306,27 @@ Class | Method | HTTP request | Description - [FIServicerAdvancesForSecurities](docs/FIServicerAdvancesForSecurities.md) - [FIStructuredProductsForJobSettings](docs/FIStructuredProductsForJobSettings.md) - [FIStructuredProductsForSecurities](docs/FIStructuredProductsForSecurities.md) + - [FPOAccount](docs/FPOAccount.md) + - [FPOObjective](docs/FPOObjective.md) + - [FPOOptimizationParameters](docs/FPOOptimizationParameters.md) + - [FPOOptimizationParametersRoot](docs/FPOOptimizationParametersRoot.md) + - [FPOOptimizerStrategy](docs/FPOOptimizerStrategy.md) + - [FPOOptimizerStrategyOverrides](docs/FPOOptimizerStrategyOverrides.md) - [Frequency](docs/Frequency.md) - [FrequencyRoot](docs/FrequencyRoot.md) + - [Group](docs/Group.md) + - [GroupRoot](docs/GroupRoot.md) + - [LinkedPATemplate](docs/LinkedPATemplate.md) + - [LinkedPATemplateParameters](docs/LinkedPATemplateParameters.md) + - [LinkedPATemplateParametersRoot](docs/LinkedPATemplateParametersRoot.md) + - [LinkedPATemplatePostSummary](docs/LinkedPATemplatePostSummary.md) + - [LinkedPATemplatePostSummaryRoot](docs/LinkedPATemplatePostSummaryRoot.md) + - [LinkedPATemplateRoot](docs/LinkedPATemplateRoot.md) + - [LinkedPATemplateSummary](docs/LinkedPATemplateSummary.md) + - [LinkedPATemplateSummaryRoot](docs/LinkedPATemplateSummaryRoot.md) + - [LinkedPATemplateUpdateParameters](docs/LinkedPATemplateUpdateParameters.md) + - [LinkedPATemplateUpdateParametersRoot](docs/LinkedPATemplateUpdateParametersRoot.md) + - [Metadata](docs/Metadata.md) - [NPOOptimizationParameters](docs/NPOOptimizationParameters.md) - [NPOOptimizationParametersRoot](docs/NPOOptimizationParametersRoot.md) - [NPOOptimizerStrategy](docs/NPOOptimizerStrategy.md) @@ -268,6 +339,31 @@ Class | Method | HTTP request | Description - [OptimizerOptimalHoldings](docs/OptimizerOptimalHoldings.md) - [OptimizerOutputTypes](docs/OptimizerOutputTypes.md) - [OptimizerTradesList](docs/OptimizerTradesList.md) + - [PACalculationColumn](docs/PACalculationColumn.md) + - [PACalculationDataSources](docs/PACalculationDataSources.md) + - [PACalculationGroup](docs/PACalculationGroup.md) + - [PACalculationParameters](docs/PACalculationParameters.md) + - [PACalculationParametersRoot](docs/PACalculationParametersRoot.md) + - [PACalculationPricingSource](docs/PACalculationPricingSource.md) + - [PACommentary](docs/PACommentary.md) + - [PACommentaryConfigurationSummary](docs/PACommentaryConfigurationSummary.md) + - [PACommentaryConfigurationSummaryRoot](docs/PACommentaryConfigurationSummaryRoot.md) + - [PACommentaryDate](docs/PACommentaryDate.md) + - [PACommentaryGetStatus](docs/PACommentaryGetStatus.md) + - [PACommentaryGetStatusRoot](docs/PACommentaryGetStatusRoot.md) + - [PACommentaryParameters](docs/PACommentaryParameters.md) + - [PACommentaryParametersRoot](docs/PACommentaryParametersRoot.md) + - [PACommentaryRoot](docs/PACommentaryRoot.md) + - [PACommentaryStatus](docs/PACommentaryStatus.md) + - [PACommentaryStatusRoot](docs/PACommentaryStatusRoot.md) + - [PAComponent](docs/PAComponent.md) + - [PAComponentData](docs/PAComponentData.md) + - [PAComponentRoot](docs/PAComponentRoot.md) + - [PADateParameters](docs/PADateParameters.md) + - [PAIdentifier](docs/PAIdentifier.md) + - [PAPricingSource](docs/PAPricingSource.md) + - [PAPricingSourceRoot](docs/PAPricingSourceRoot.md) + - [PaDoc](docs/PaDoc.md) - [PaginationInfo](docs/PaginationInfo.md) - [PaginationMeta](docs/PaginationMeta.md) - [PubCalculationParameters](docs/PubCalculationParameters.md) @@ -300,6 +396,34 @@ Class | Method | HTTP request | Description - [SPARComponentRoot](docs/SPARComponentRoot.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) + - [Section](docs/Section.md) + - [TemplateContentTypes](docs/TemplateContentTypes.md) + - [TemplatedPAComponent](docs/TemplatedPAComponent.md) + - [TemplatedPAComponentParameters](docs/TemplatedPAComponentParameters.md) + - [TemplatedPAComponentParametersRoot](docs/TemplatedPAComponentParametersRoot.md) + - [TemplatedPAComponentPostSummary](docs/TemplatedPAComponentPostSummary.md) + - [TemplatedPAComponentPostSummaryRoot](docs/TemplatedPAComponentPostSummaryRoot.md) + - [TemplatedPAComponentRoot](docs/TemplatedPAComponentRoot.md) + - [TemplatedPAComponentSummary](docs/TemplatedPAComponentSummary.md) + - [TemplatedPAComponentSummaryRoot](docs/TemplatedPAComponentSummaryRoot.md) + - [TemplatedPAComponentUpdateParameters](docs/TemplatedPAComponentUpdateParameters.md) + - [TemplatedPAComponentUpdateParametersRoot](docs/TemplatedPAComponentUpdateParametersRoot.md) + - [UnlinkedPATemplate](docs/UnlinkedPATemplate.md) + - [UnlinkedPATemplateCategoryAndType](docs/UnlinkedPATemplateCategoryAndType.md) + - [UnlinkedPATemplateCategoryAndTypeDetails](docs/UnlinkedPATemplateCategoryAndTypeDetails.md) + - [UnlinkedPATemplateCategoryAndTypeDetailsRoot](docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md) + - [UnlinkedPATemplateCategoryAndTypeRoot](docs/UnlinkedPATemplateCategoryAndTypeRoot.md) + - [UnlinkedPATemplateColumnDetails](docs/UnlinkedPATemplateColumnDetails.md) + - [UnlinkedPATemplateGroupDetails](docs/UnlinkedPATemplateGroupDetails.md) + - [UnlinkedPATemplateParameters](docs/UnlinkedPATemplateParameters.md) + - [UnlinkedPATemplateParametersRoot](docs/UnlinkedPATemplateParametersRoot.md) + - [UnlinkedPATemplatePostSummary](docs/UnlinkedPATemplatePostSummary.md) + - [UnlinkedPATemplatePostSummaryRoot](docs/UnlinkedPATemplatePostSummaryRoot.md) + - [UnlinkedPATemplateRoot](docs/UnlinkedPATemplateRoot.md) + - [UnlinkedPATemplateSummary](docs/UnlinkedPATemplateSummary.md) + - [UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md) + - [UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md) + - [UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md) - [VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md) - [VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md) - [VaultCalculationParameters](docs/VaultCalculationParameters.md) diff --git a/auto-generated-sdk/docs/Column.md b/auto-generated-sdk/docs/Column.md new file mode 100644 index 00000000..9f70e302 --- /dev/null +++ b/auto-generated-sdk/docs/Column.md @@ -0,0 +1,14 @@ +# Column + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**defaultstatisticsids** | **[str]** | Column statistic Id | [optional] +**name** | **str** | Column Name | [optional] +**directory** | **str** | Column Directory | [optional] +**category** | **str** | Column Category | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/ColumnRoot.md b/auto-generated-sdk/docs/ColumnRoot.md new file mode 100644 index 00000000..35630808 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnRoot.md @@ -0,0 +1,12 @@ +# ColumnRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**Column**](Column.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/ColumnStatistic.md b/auto-generated-sdk/docs/ColumnStatistic.md new file mode 100644 index 00000000..64af5560 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnStatistic.md @@ -0,0 +1,11 @@ +# ColumnStatistic + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Column Statistic Name | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/ColumnStatisticRoot.md b/auto-generated-sdk/docs/ColumnStatisticRoot.md new file mode 100644 index 00000000..9b56aab0 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnStatisticRoot.md @@ -0,0 +1,12 @@ +# ColumnStatisticRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (ColumnStatistic,)}**](ColumnStatistic.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/ColumnStatisticsApi.md b/auto-generated-sdk/docs/ColumnStatisticsApi.md new file mode 100644 index 00000000..fde2a8d5 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnStatisticsApi.md @@ -0,0 +1,95 @@ + +# fds.analyticsapi.engines.ColumnStatisticsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_pa_column_statistics**](ColumnStatisticsApi.md#get_pa_column_statistics) | **GET** /analytics/engines/pa/v3/columnstatistics | Get PA column statistics + + +# **get_pa_column_statistics** +> ColumnStatisticRoot get_pa_column_statistics() + +Get PA column statistics + +This endpoint lists all the column statistics that can be applied to a PA column. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import column_statistics_api +from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = column_statistics_api.ColumnStatisticsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Get PA column statistics + api_response = api_instance.get_pa_column_statistics() + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling ColumnStatisticsApi->get_pa_column_statistics: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**ColumnStatisticRoot**](ColumnStatisticRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/ColumnSummary.md b/auto-generated-sdk/docs/ColumnSummary.md new file mode 100644 index 00000000..46bc660f --- /dev/null +++ b/auto-generated-sdk/docs/ColumnSummary.md @@ -0,0 +1,14 @@ +# ColumnSummary + +Column settings (name, directory, category) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Column Name | [optional] +**directory** | **str** | Column Directory | [optional] +**category** | **str** | Column Category | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/ColumnSummaryRoot.md b/auto-generated-sdk/docs/ColumnSummaryRoot.md new file mode 100644 index 00000000..ccc1f118 --- /dev/null +++ b/auto-generated-sdk/docs/ColumnSummaryRoot.md @@ -0,0 +1,12 @@ +# ColumnSummaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (ColumnSummary,)}**](ColumnSummary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/ColumnsApi.md b/auto-generated-sdk/docs/ColumnsApi.md new file mode 100644 index 00000000..5a64878c --- /dev/null +++ b/auto-generated-sdk/docs/ColumnsApi.md @@ -0,0 +1,197 @@ + +# fds.analyticsapi.engines.ColumnsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_pa_column_by_id**](ColumnsApi.md#get_pa_column_by_id) | **GET** /analytics/engines/pa/v3/columns/{id} | Get PA column settings +[**get_pa_columns**](ColumnsApi.md#get_pa_columns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns + + +# **get_pa_column_by_id** +> ColumnRoot get_pa_column_by_id(id) + +Get PA column settings + +This endpoint returns the default settings of a PA column. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import columns_api +from fds.analyticsapi.engines.model.column_root import ColumnRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = columns_api.ColumnsApi(api_client) + id = "2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7" # str | Unique identifier for a column + + # example passing only required values which don't have defaults set + try: + # Get PA column settings + api_response = api_instance.get_pa_column_by_id(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling ColumnsApi->get_pa_column_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for a column | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**ColumnRoot**](ColumnRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pa_columns** +> ColumnSummaryRoot get_pa_columns() + +Get PA columns + +This endpoint lists all the PA columns that can be applied to a calculation. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import columns_api +from fds.analyticsapi.engines.model.column_summary_root import ColumnSummaryRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = columns_api.ColumnsApi(api_client) + name = "Security Name" # str | Column name (optional) if omitted the server will use the default value of "" + category = "" # str | Column category (optional) if omitted the server will use the default value of "" + directory = "Client" # str | The directory to get the columns in (optional) if omitted the server will use the default value of "" + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get PA columns + api_response = api_instance.get_pa_columns(name=name, category=category, directory=directory) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling ColumnsApi->get_pa_columns: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| Column name | [optional] if omitted the server will use the default value of "" + **category** | **str**| Column category | [optional] if omitted the server will use the default value of "" + **directory** | **str**| The directory to get the columns in | [optional] if omitted the server will use the default value of "" + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**ColumnSummaryRoot**](ColumnSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index e6d82125..7d23bd1b 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -5,12 +5,198 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**get_pa_component_by_id**](ComponentsApi.md#get_pa_component_by_id) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id +[**get_pa_components**](ComponentsApi.md#get_pa_components) | **GET** /analytics/engines/pa/v3/components | Get PA components [**get_spar_component_by_id**](ComponentsApi.md#get_spar_component_by_id) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id [**get_spar_components**](ComponentsApi.md#get_spar_components) | **GET** /analytics/engines/spar/v3/components | Get SPAR components [**get_vault_component_by_id**](ComponentsApi.md#get_vault_component_by_id) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id [**get_vault_components**](ComponentsApi.md#get_vault_components) | **GET** /analytics/engines/vault/v3/components | Get Vault components +# **get_pa_component_by_id** +> PAComponentRoot get_pa_component_by_id(id) + +Get PA component by id + +This endpoint returns the default settings of a PA component. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import components_api +from fds.analyticsapi.engines.model.pa_component_root import PAComponentRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = components_api.ComponentsApi(api_client) + id = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" # str | Unique identifier for a PA component + + # example passing only required values which don't have defaults set + try: + # Get PA component by id + api_response = api_instance.get_pa_component_by_id(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling ComponentsApi->get_pa_component_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for a PA component | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**PAComponentRoot**](PAComponentRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns the default settings of a 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pa_components** +> ComponentSummaryRoot get_pa_components(document) + +Get PA components + +This endpoint returns the list of PA components in a given PA document. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import components_api +from fds.analyticsapi.engines.model.component_summary_root import ComponentSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = components_api.ComponentsApi(api_client) + document = "PA3_DOCUMENTS:DEFAULT" # str | Document Name + + # example passing only required values which don't have defaults set + try: + # Get PA components + api_response = api_instance.get_pa_components(document) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling ComponentsApi->get_pa_components: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **document** | **str**| Document Name | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**ComponentSummaryRoot**](ComponentSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of PA components. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Document not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_spar_component_by_id** > SPARComponentRoot get_spar_component_by_id(id) diff --git a/auto-generated-sdk/docs/ConfigurationsApi.md b/auto-generated-sdk/docs/ConfigurationsApi.md index f9dc5c7e..65f5f92c 100644 --- a/auto-generated-sdk/docs/ConfigurationsApi.md +++ b/auto-generated-sdk/docs/ConfigurationsApi.md @@ -5,10 +5,102 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**get_pa_commentary_configurations**](ConfigurationsApi.md#get_pa_commentary_configurations) | **GET** /analytics/engines/pa/v3/commentary/configurations | Get PA commentary configurations in a directory [**get_vault_configuration_by_id**](ConfigurationsApi.md#get_vault_configuration_by_id) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id [**get_vault_configurations**](ConfigurationsApi.md#get_vault_configurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations +# **get_pa_commentary_configurations** +> PACommentaryConfigurationSummaryRoot get_pa_commentary_configurations(path) + +Get PA commentary configurations in a directory + +This endpoint returns all PA commentary configurations in a given directory. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import configurations_api +from fds.analyticsapi.engines.model.pa_commentary_configuration_summary_root import PACommentaryConfigurationSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = configurations_api.ConfigurationsApi(api_client) + path = "Client:" # str | The directory to get the PA commentary configurations + + # example passing only required values which don't have defaults set + try: + # Get PA commentary configurations in a directory + api_response = api_instance.get_pa_commentary_configurations(path) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling ConfigurationsApi->get_pa_commentary_configurations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| The directory to get the PA commentary configurations | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**PACommentaryConfigurationSummaryRoot**](PACommentaryConfigurationSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a map of configuration ID to PA commentary 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid path provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in 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.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_vault_configuration_by_id** > VaultConfigurationRoot get_vault_configuration_by_id(id) diff --git a/auto-generated-sdk/docs/DatesApi.md b/auto-generated-sdk/docs/DatesApi.md index 3f378315..f238c057 100644 --- a/auto-generated-sdk/docs/DatesApi.md +++ b/auto-generated-sdk/docs/DatesApi.md @@ -5,9 +5,117 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**convert_pa_dates_to_absolute_format**](DatesApi.md#convert_pa_dates_to_absolute_format) | **GET** /analytics/engines/pa/v3/dates | Convert PA dates to absolute format [**convert_vault_dates_to_absolute_format**](DatesApi.md#convert_vault_dates_to_absolute_format) | **GET** /analytics/engines/vault/v3/dates | Convert Vault dates to absolute format +# **convert_pa_dates_to_absolute_format** +> DateParametersSummaryRoot convert_pa_dates_to_absolute_format(enddate, componentid, account) + +Convert PA dates to absolute format + +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 + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import dates_api +from fds.analyticsapi.engines.model.date_parameters_summary_root import DateParametersSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dates_api.DatesApi(api_client) + enddate = "-1AY" # str | End Date + componentid = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46" # str | Component Id + account = "Client:/Folder1/Folder2/AccountName.ACCT" # str | Account ( Account Name ending with .ACCT or .ACTM ) + startdate = "-3AY" # str | Start Date (optional) + + # example passing only required values which don't have defaults set + try: + # Convert PA dates to absolute format + api_response = api_instance.convert_pa_dates_to_absolute_format(enddate, componentid, account) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling DatesApi->convert_pa_dates_to_absolute_format: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Convert PA dates to absolute format + api_response = api_instance.convert_pa_dates_to_absolute_format(enddate, componentid, account, startdate=startdate) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling DatesApi->convert_pa_dates_to_absolute_format: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **enddate** | **str**| End Date | + **componentid** | **str**| Component Id | + **account** | **str**| Account ( Account Name ending with .ACCT or .ACTM ) | + **startdate** | **str**| Start Date | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**DateParametersSummaryRoot**](DateParametersSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns the 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Document 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **convert_vault_dates_to_absolute_format** > DateParametersSummaryRoot convert_vault_dates_to_absolute_format(enddate, componentid, account) diff --git a/auto-generated-sdk/docs/DocumentsApi.md b/auto-generated-sdk/docs/DocumentsApi.md index e11e39de..787fdec2 100644 --- a/auto-generated-sdk/docs/DocumentsApi.md +++ b/auto-generated-sdk/docs/DocumentsApi.md @@ -5,11 +5,104 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**get_pa3_documents**](DocumentsApi.md#get_pa3_documents) | **GET** /analytics/engines/pa/v3/documents/{path} | Get PA3 documents and sub-directories in a directory [**get_pub_documents**](DocumentsApi.md#get_pub_documents) | **GET** /analytics/engines/pub/v3/documents/{path} | Gets Publisher documents and sub-directories in a directory [**get_spar3_documents**](DocumentsApi.md#get_spar3_documents) | **GET** /analytics/engines/spar/v3/documents/{path} | Gets SPAR3 documents and sub-directories in a directory [**get_vault_documents**](DocumentsApi.md#get_vault_documents) | **GET** /analytics/engines/vault/v3/documents/{path} | Get Vault documents and sub-directories in a directory +# **get_pa3_documents** +> DocumentDirectoriesRoot get_pa3_documents(path) + +Get PA3 documents and sub-directories in a directory + +This endpoint looks up all PA3 documents and sub-directories in a given directory. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import documents_api +from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = documents_api.DocumentsApi(api_client) + path = "Client:" # str | The directory to get the documents and sub-directories in + + # example passing only required values which don't have defaults set + try: + # Get PA3 documents and sub-directories in a directory + api_response = api_instance.get_pa3_documents(path) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling DocumentsApi->get_pa3_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| The directory to get the documents and sub-directories in | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**DocumentDirectoriesRoot**](DocumentDirectoriesRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in 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.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_pub_documents** > DocumentDirectoriesRoot get_pub_documents(path) diff --git a/auto-generated-sdk/docs/FPOAccount.md b/auto-generated-sdk/docs/FPOAccount.md new file mode 100644 index 00000000..d9f394ac --- /dev/null +++ b/auto-generated-sdk/docs/FPOAccount.md @@ -0,0 +1,13 @@ +# FPOAccount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pa_document** | [**PaDoc**](PaDoc.md) | | +**id** | **str** | Account path | [optional] +**overrides** | [**OptimizerAccountOverrides**](OptimizerAccountOverrides.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/FPOObjective.md b/auto-generated-sdk/docs/FPOObjective.md new file mode 100644 index 00000000..ec3a4948 --- /dev/null +++ b/auto-generated-sdk/docs/FPOObjective.md @@ -0,0 +1,12 @@ +# FPOObjective + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active** | **str** | | [optional] +**terms** | **{str: (str,)}** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/FPOOptimizationParameters.md b/auto-generated-sdk/docs/FPOOptimizationParameters.md new file mode 100644 index 00000000..c2d5c271 --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizationParameters.md @@ -0,0 +1,14 @@ +# FPOOptimizationParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**strategy** | [**FPOOptimizerStrategy**](FPOOptimizerStrategy.md) | | +**output_types** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | +**account** | [**FPOAccount**](FPOAccount.md) | | [optional] +**optimization** | [**Optimization**](Optimization.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md b/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md new file mode 100644 index 00000000..d5e65cc5 --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizationParametersRoot.md @@ -0,0 +1,12 @@ +# FPOOptimizationParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**FPOOptimizationParameters**](FPOOptimizationParameters.md) | | [optional] +**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/FPOOptimizerApi.md b/auto-generated-sdk/docs/FPOOptimizerApi.md new file mode 100644 index 00000000..f2f1f745 --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizerApi.md @@ -0,0 +1,708 @@ + +# fds.analyticsapi.engines.FPOOptimizerApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel_optimization_by_id**](FPOOptimizerApi.md#cancel_optimization_by_id) | **DELETE** /analytics/engines/fpo/v3/optimizations/{id} | Cancel FPO optimization by id +[**get_optimization_parameters**](FPOOptimizerApi.md#get_optimization_parameters) | **GET** /analytics/engines/fpo/v3/optimizations/{id} | Get FPO optimization parameters by id +[**get_optimization_result**](FPOOptimizerApi.md#get_optimization_result) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/result | Get FPO optimization result by id +[**get_optimization_status_by_id**](FPOOptimizerApi.md#get_optimization_status_by_id) | **GET** /analytics/engines/fpo/v3/optimizations/{id}/status | Get FPO optimization status by id +[**post_and_optimize**](FPOOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/fpo/v3/optimizations | Create and Run FPO optimization +[**put_and_optimize**](FPOOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/fpo/v3/optimizations/{id} | Create or Update FPO optimization and run it. + + +# **cancel_optimization_by_id** +> cancel_optimization_by_id(id) + +Cancel FPO optimization by id + +This is the endpoint to cancel a previously submitted optimization. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import fpo_optimizer_api +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Create and Run FPO optimization endpoint + + # example passing only required values which don't have defaults set + try: + # Cancel FPO optimization by id + api_instance.cancel_optimization_by_id(id) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FPOOptimizerApi->cancel_optimization_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Create and Run FPO optimization endpoint | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: None (empty response body) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Expected response, 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_optimization_parameters** +> FPOOptimizationParametersRoot get_optimization_parameters(id) + +Get FPO optimization parameters by id + +This is the endpoint that returns the optimization parameters passed for an optimization. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import fpo_optimizer_api +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Create and Run FPO optimization endpoint + + # example passing only required values which don't have defaults set + try: + # Get FPO optimization parameters by id + api_response = api_instance.get_optimization_parameters(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FPOOptimizerApi->get_optimization_parameters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Create and Run FPO optimization endpoint | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns the FPO optimization parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Optimization 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_optimization_result** +> ObjectRoot get_optimization_result(id) + +Get FPO optimization result by id + +This is the endpoint to get the result of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import fpo_optimizer_api +from fds.analyticsapi.engines.model.object_root import ObjectRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Get FPO optimization status by id endpoint + accept = "Accept_example" # str | Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * (optional) + + # example passing only required values which don't have defaults set + try: + # Get FPO optimization result by id + api_response = api_instance.get_optimization_result(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FPOOptimizerApi->get_optimization_result: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get FPO optimization result by id + api_response = api_instance.get_optimization_result(id, accept=accept) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FPOOptimizerApi->get_optimization_result: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Get FPO optimization status by id endpoint | + **accept** | **str**| Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or * | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**ObjectRoot**](ObjectRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response once optimization is completed, returns JSON. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_optimization_status_by_id** +> ObjectRoot get_optimization_status_by_id(id) + +Get FPO optimization status 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 + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import fpo_optimizer_api +from fds.analyticsapi.engines.model.object_root import ObjectRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Create and Run FPO optimization endpoint + + # example passing only required values which don't have defaults set + try: + # Get FPO optimization status by id + api_response = api_instance.get_optimization_status_by_id(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FPOOptimizerApi->get_optimization_status_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Create and Run FPO optimization endpoint | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: (For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 202 status - None (empty response body) ) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Expected response once optimization is completed, returns JSON. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_and_optimize** +> ObjectRoot post_and_optimize() + +Create and Run FPO optimization + +This endpoint runs FPO optimization specified in the POST body parameters. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import fpo_optimizer_api +from fds.analyticsapi.engines.model.object_root import ObjectRoot +from fds.analyticsapi.engines.model.calculation_info_root import CalculationInfoRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) + x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional) + fpo_optimization_parameters_root = FPOOptimizationParametersRoot( + data=FPOOptimizationParameters( + account=FPOAccount( + pa_document=PaDoc( + id="id_example", + ), + id="id_example", + overrides=OptimizerAccountOverrides( + portfolio="portfolio_example", + benchmark="benchmark_example", + risk_model_id="risk_model_id_example", + currency="currency_example", + ), + ), + strategy=FPOOptimizerStrategy( + overrides=FPOOptimizerStrategyOverrides( + objective=FPOObjective( + active="active_example", + terms={ + "Disable": "Disable", + }, + ), + constraints={ + "Disable": "Disable", + }, + alpha="alpha_example", + transaction_cost="transaction_cost_example", + ), + id="id_example", + ), + optimization=Optimization( + risk_model_date="risk_model_date_example", + backtest_date="backtest_date_example", + cashflow="cashflow_example", + ), + output_types=OptimizerOutputTypes( + trades=OptimizerTradesList( + identifier_type="Asset", + include_cash=True, + ), + optimal=OptimizerOptimalHoldings( + identifier_type="Asset", + include_cash=True, + exclude_zero=True, + ), + account=OptimalPortfolio( + acct_name="acct_name_example", + exclude_zero=True, + archive_date="archive_date_example", + if_acct_exists="abort", + if_ofdb_date_exists="abort", + ), + stats={}, + ), + ), + meta={}, + ) # FPOOptimizationParametersRoot | Optimization Parameters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create and Run FPO optimization + api_response = api_instance.post_and_optimize(x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, fpo_optimization_parameters_root=fpo_optimization_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FPOOptimizerApi->post_and_optimize: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] + **cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional] + **fpo_optimization_parameters_root** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md)) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Expected response, contains the poll URL in the Location header. | * 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**201** | Expected response, returns json if optimization is completed in a short span. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid optimization parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | One or more 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Cancel older requests using Cancel 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **put_and_optimize** +> ObjectRoot put_and_optimize(id) + +Create or Update FPO optimization and run it. + +This endpoint updates and run the FPO optimization specified in the PUT body parameters. It also allows the creation of new FPO optimization with custom id. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import fpo_optimizer_api +from fds.analyticsapi.engines.model.object_root import ObjectRoot +from fds.analyticsapi.engines.model.calculation_info_root import CalculationInfoRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = fpo_optimizer_api.FPOOptimizerApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Create and Run FPO optimization endpoint + x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional) + fpo_optimization_parameters_root = FPOOptimizationParametersRoot( + data=FPOOptimizationParameters( + account=FPOAccount( + pa_document=PaDoc( + id="id_example", + ), + id="id_example", + overrides=OptimizerAccountOverrides( + portfolio="portfolio_example", + benchmark="benchmark_example", + risk_model_id="risk_model_id_example", + currency="currency_example", + ), + ), + strategy=FPOOptimizerStrategy( + overrides=FPOOptimizerStrategyOverrides( + objective=FPOObjective( + active="active_example", + terms={ + "Disable": "Disable", + }, + ), + constraints={ + "Disable": "Disable", + }, + alpha="alpha_example", + transaction_cost="transaction_cost_example", + ), + id="id_example", + ), + optimization=Optimization( + risk_model_date="risk_model_date_example", + backtest_date="backtest_date_example", + cashflow="cashflow_example", + ), + output_types=OptimizerOutputTypes( + trades=OptimizerTradesList( + identifier_type="Asset", + include_cash=True, + ), + optimal=OptimizerOptimalHoldings( + identifier_type="Asset", + include_cash=True, + exclude_zero=True, + ), + account=OptimalPortfolio( + acct_name="acct_name_example", + exclude_zero=True, + archive_date="archive_date_example", + if_acct_exists="abort", + if_ofdb_date_exists="abort", + ), + stats={}, + ), + ), + meta={}, + ) # FPOOptimizationParametersRoot | Optimization Parameters (optional) + + # example passing only required values which don't have defaults set + try: + # Create or Update FPO optimization and run it. + api_response = api_instance.put_and_optimize(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FPOOptimizerApi->put_and_optimize: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create or Update FPO optimization and run it. + api_response = api_instance.put_and_optimize(id, x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, fpo_optimization_parameters_root=fpo_optimization_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FPOOptimizerApi->put_and_optimize: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Create and Run FPO optimization endpoint | + **x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] + **cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional] + **fpo_optimization_parameters_root** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md)) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Expected response, contains the poll URL in the Location header. | * 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**201** | Expected response, returns json if optimization is completed in a short span. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid Optimization Parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | One or more 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**409** | Duplicate optimization exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Cancel older requests using Cancel 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/FPOOptimizerStrategy.md b/auto-generated-sdk/docs/FPOOptimizerStrategy.md new file mode 100644 index 00000000..fed697c5 --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizerStrategy.md @@ -0,0 +1,12 @@ +# FPOOptimizerStrategy + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | OptimizerStrategy document path | +**overrides** | [**FPOOptimizerStrategyOverrides**](FPOOptimizerStrategyOverrides.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md b/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md new file mode 100644 index 00000000..9c8724a0 --- /dev/null +++ b/auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md @@ -0,0 +1,14 @@ +# FPOOptimizerStrategyOverrides + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objective** | [**FPOObjective**](FPOObjective.md) | | [optional] +**constraints** | **{str: (str,)}** | List of constraints | [optional] +**alpha** | **str** | Alpha | [optional] +**transaction_cost** | **str** | Transaction cost | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/FrequenciesApi.md b/auto-generated-sdk/docs/FrequenciesApi.md index fe2edbf9..26b3b99c 100644 --- a/auto-generated-sdk/docs/FrequenciesApi.md +++ b/auto-generated-sdk/docs/FrequenciesApi.md @@ -5,10 +5,96 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**get_pa_frequencies**](FrequenciesApi.md#get_pa_frequencies) | **GET** /analytics/engines/pa/v3/frequencies | Get PA frequencies [**get_spar_frequencies**](FrequenciesApi.md#get_spar_frequencies) | **GET** /analytics/engines/spar/v3/frequencies | Get SPAR frequencies [**get_vault_frequencies**](FrequenciesApi.md#get_vault_frequencies) | **GET** /analytics/engines/vault/v3/frequencies | Get Vault frequencies +# **get_pa_frequencies** +> FrequencyRoot get_pa_frequencies() + +Get PA frequencies + +This endpoint lists all the frequencies that can be applied to a PA calculation. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import frequencies_api +from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = frequencies_api.FrequenciesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Get PA frequencies + api_response = api_instance.get_pa_frequencies() + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling FrequenciesApi->get_pa_frequencies: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**FrequencyRoot**](FrequencyRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_spar_frequencies** > FrequencyRoot get_spar_frequencies() diff --git a/auto-generated-sdk/docs/Group.md b/auto-generated-sdk/docs/Group.md new file mode 100644 index 00000000..d9b4ac4b --- /dev/null +++ b/auto-generated-sdk/docs/Group.md @@ -0,0 +1,13 @@ +# Group + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Group Name | [optional] +**directory** | **str** | Group Directory | [optional] +**category** | **str** | Group Category | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/GroupRoot.md b/auto-generated-sdk/docs/GroupRoot.md new file mode 100644 index 00000000..5e4fa466 --- /dev/null +++ b/auto-generated-sdk/docs/GroupRoot.md @@ -0,0 +1,12 @@ +# GroupRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (Group,)}**](Group.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/GroupsApi.md b/auto-generated-sdk/docs/GroupsApi.md new file mode 100644 index 00000000..859b236b --- /dev/null +++ b/auto-generated-sdk/docs/GroupsApi.md @@ -0,0 +1,181 @@ + +# fds.analyticsapi.engines.GroupsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_pa_grouping_frequencies**](GroupsApi.md#get_pa_grouping_frequencies) | **GET** /analytics/engines/pa/v3/grouping-frequencies | Get PA grouping frequencies +[**get_pa_groups**](GroupsApi.md#get_pa_groups) | **GET** /analytics/engines/pa/v3/groups | Get PA groups + + +# **get_pa_grouping_frequencies** +> FrequencyRoot get_pa_grouping_frequencies() + +Get PA grouping frequencies + +This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import groups_api +from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = groups_api.GroupsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Get PA grouping frequencies + api_response = api_instance.get_pa_grouping_frequencies() + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling GroupsApi->get_pa_grouping_frequencies: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**FrequencyRoot**](FrequencyRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of PA grouping 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pa_groups** +> GroupRoot get_pa_groups() + +Get PA groups + +This endpoint lists all the PA groups that can be applied to a PA calculation. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import groups_api +from fds.analyticsapi.engines.model.group_root import GroupRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = groups_api.GroupsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Get PA groups + api_response = api_instance.get_pa_groups() + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling GroupsApi->get_pa_groups: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**GroupRoot**](GroupRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/LinkedPATemplate.md b/auto-generated-sdk/docs/LinkedPATemplate.md new file mode 100644 index 00000000..1de1b491 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplate.md @@ -0,0 +1,17 @@ +# LinkedPATemplate + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **str** | Template directory. | [optional] +**snapshot** | **bool** | snapshot. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] +**id** | **str** | Template id. | [optional] +**description** | **str** | Template description. | [optional] +**name** | **str** | Template name. | [optional] +**parent_component_id** | **str** | Template parent tile. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateParameters.md new file mode 100644 index 00000000..8cb94bd8 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateParameters.md @@ -0,0 +1,14 @@ +# LinkedPATemplateParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **str** | The directory to create a linked PA template | +**parent_component_id** | **str** | Parent component id | +**description** | **str** | Template description | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md new file mode 100644 index 00000000..d44c9d1c --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md @@ -0,0 +1,12 @@ +# LinkedPATemplateParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplateParameters**](LinkedPATemplateParameters.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md new file mode 100644 index 00000000..7fddec54 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplatePostSummary.md @@ -0,0 +1,14 @@ +# LinkedPATemplatePostSummary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Template id. | [optional] +**description** | **str** | Template description. | [optional] +**name** | **str** | Template name. | [optional] +**parent_component_id** | **str** | Template parent tile. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md new file mode 100644 index 00000000..fe14ecb4 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md @@ -0,0 +1,12 @@ +# LinkedPATemplatePostSummaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplatePostSummary**](LinkedPATemplatePostSummary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateRoot.md b/auto-generated-sdk/docs/LinkedPATemplateRoot.md new file mode 100644 index 00000000..ceffbce9 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateRoot.md @@ -0,0 +1,12 @@ +# LinkedPATemplateRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplate**](LinkedPATemplate.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummary.md b/auto-generated-sdk/docs/LinkedPATemplateSummary.md new file mode 100644 index 00000000..a4215a1a --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateSummary.md @@ -0,0 +1,13 @@ +# LinkedPATemplateSummary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Template description. | [optional] +**name** | **str** | Template name. | [optional] +**parent_component_id** | **str** | Template parent tile. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md new file mode 100644 index 00000000..1aeb776c --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md @@ -0,0 +1,12 @@ +# LinkedPATemplateSummaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (LinkedPATemplateSummary,)}**](LinkedPATemplateSummary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md new file mode 100644 index 00000000..822eed8b --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md @@ -0,0 +1,13 @@ +# LinkedPATemplateUpdateParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parent_component_id** | **str** | Parent component id | [optional] +**description** | **str** | Template description | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md new file mode 100644 index 00000000..e9f957f4 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md @@ -0,0 +1,12 @@ +# LinkedPATemplateUpdateParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LinkedPATemplateUpdateParameters**](LinkedPATemplateUpdateParameters.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/LinkedPATemplatesApi.md b/auto-generated-sdk/docs/LinkedPATemplatesApi.md new file mode 100644 index 00000000..43178503 --- /dev/null +++ b/auto-generated-sdk/docs/LinkedPATemplatesApi.md @@ -0,0 +1,516 @@ + +# fds.analyticsapi.engines.LinkedPATemplatesApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_linked_pa_templates**](LinkedPATemplatesApi.md#create_linked_pa_templates) | **POST** /analytics/engines/pa/v3/linked-templates | Create a linked PA template +[**delete_linked_pa_templates**](LinkedPATemplatesApi.md#delete_linked_pa_templates) | **DELETE** /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. +[**get_linked_pa_templates**](LinkedPATemplatesApi.md#get_linked_pa_templates) | **GET** /analytics/engines/pa/v3/linked-templates | Get linked PA templates +[**get_linked_pa_templates_by_id**](LinkedPATemplatesApi.md#get_linked_pa_templates_by_id) | **GET** /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id +[**update_linked_pa_templates**](LinkedPATemplatesApi.md#update_linked_pa_templates) | **PUT** /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template + + +# **create_linked_pa_templates** +> LinkedPATemplatePostSummaryRoot create_linked_pa_templates(linked_pa_template_parameters_root) + +Create a linked PA template + +This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import linked_pa_templates_api +from fds.analyticsapi.engines.model.linked_pa_template_post_summary_root import LinkedPATemplatePostSummaryRoot +from fds.analyticsapi.engines.model.linked_pa_template_parameters_root import LinkedPATemplateParametersRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) + linked_pa_template_parameters_root = LinkedPATemplateParametersRoot( + data=LinkedPATemplateParameters( + directory="directory_example", + parent_component_id="parent_component_id_example", + description="description_example", + content=TemplateContentTypes( + mandatory=[ + "mandatory_example", + ], + optional=[ + "optional_example", + ], + locked=[ + "locked_example", + ], + ), + ), + meta=None, + ) # LinkedPATemplateParametersRoot | Request Parameters + + # example passing only required values which don't have defaults set + try: + # Create a linked PA template + api_response = api_instance.create_linked_pa_templates(linked_pa_template_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling LinkedPATemplatesApi->create_linked_pa_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linked_pa_template_parameters_root** | [**LinkedPATemplateParametersRoot**](LinkedPATemplateParametersRoot.md)| Request Parameters | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Expected response, created a template linked to a PA3 tile. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_linked_pa_templates** +> delete_linked_pa_templates(id) + +Delete a linked PA template. + +This endpoint deletes an existing linked PA template. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import linked_pa_templates_api +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for a linked PA template + + # example passing only required values which don't have defaults set + try: + # Delete a linked PA template. + api_instance.delete_linked_pa_templates(id) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling LinkedPATemplatesApi->delete_linked_pa_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for a linked PA template | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: None (empty response body) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Expected response, deleted the linked PA template successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_linked_pa_templates** +> LinkedPATemplateSummaryRoot get_linked_pa_templates() + +Get linked PA templates + +This endpoint returns the list of linked PA templates in given path. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import linked_pa_templates_api +from fds.analyticsapi.engines.model.linked_pa_template_summary_root import LinkedPATemplateSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) + directory = "Personal:LinkedPATemplates/" # str | Get linked PA templates in path. (optional) + document_directory = "documentDirectory_example" # str | Get linked PA templates for documents in document path (optional) + document_name = "documentName_example" # str | Get linked PA templates for documents by document name (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get linked PA templates + api_response = api_instance.get_linked_pa_templates(directory=directory, document_directory=document_directory, document_name=document_name) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling LinkedPATemplatesApi->get_linked_pa_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **directory** | **str**| Get linked PA templates in path. | [optional] + **document_directory** | **str**| Get linked PA templates for documents in document path | [optional] + **document_name** | **str**| Get linked PA templates for documents by document name | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**LinkedPATemplateSummaryRoot**](LinkedPATemplateSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of templates linked to PA3 tile. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Document not found | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_linked_pa_templates_by_id** +> LinkedPATemplateRoot get_linked_pa_templates_by_id(id) + +Get linked PA template by id + +This endpoint fetches the linked PA template settings. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import linked_pa_templates_api +from fds.analyticsapi.engines.model.linked_pa_template_root import LinkedPATemplateRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for a linked PA template + + # example passing only required values which don't have defaults set + try: + # Get linked PA template by id + api_response = api_instance.get_linked_pa_templates_by_id(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling LinkedPATemplatesApi->get_linked_pa_templates_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for a linked PA template | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**LinkedPATemplateRoot**](LinkedPATemplateRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, linked PA template details. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_linked_pa_templates** +> LinkedPATemplatePostSummaryRoot update_linked_pa_templates(id, linked_pa_template_update_parameters_root) + +Update a linked PA template + +This endpoint allows the user to change the request body and description from an existing template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import linked_pa_templates_api +from fds.analyticsapi.engines.model.linked_pa_template_post_summary_root import LinkedPATemplatePostSummaryRoot +from fds.analyticsapi.engines.model.linked_pa_template_update_parameters_root import LinkedPATemplateUpdateParametersRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = linked_pa_templates_api.LinkedPATemplatesApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for a linked PA template + linked_pa_template_update_parameters_root = LinkedPATemplateUpdateParametersRoot( + data=LinkedPATemplateUpdateParameters( + parent_component_id="parent_component_id_example", + description="description_example", + content=TemplateContentTypes( + mandatory=[ + "mandatory_example", + ], + optional=[ + "optional_example", + ], + locked=[ + "locked_example", + ], + ), + ), + meta=None, + ) # LinkedPATemplateUpdateParametersRoot | Request Parameters + + # example passing only required values which don't have defaults set + try: + # Update a linked PA template + api_response = api_instance.update_linked_pa_templates(id, linked_pa_template_update_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling LinkedPATemplatesApi->update_linked_pa_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for a linked PA template | + **linked_pa_template_update_parameters_root** | [**LinkedPATemplateUpdateParametersRoot**](LinkedPATemplateUpdateParametersRoot.md)| Request Parameters | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**LinkedPATemplatePostSummaryRoot**](LinkedPATemplatePostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, updated a template linked to a PA3 tile. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Template or component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/Metadata.md b/auto-generated-sdk/docs/Metadata.md new file mode 100644 index 00000000..50fa4848 --- /dev/null +++ b/auto-generated-sdk/docs/Metadata.md @@ -0,0 +1,16 @@ +# Metadata + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tile_name** | **str** | PA Tile name associated with the component | [optional] +**portfolio_description** | **str** | Portfolio name used in generating commentary | [optional] +**benchmark_description** | **str** | Benchmark name used in generating commentary | [optional] +**start_date** | [**PACommentaryDate**](PACommentaryDate.md) | | [optional] +**end_date** | [**PACommentaryDate**](PACommentaryDate.md) | | [optional] +**frequency** | **str** | Date frequency | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACalculationColumn.md b/auto-generated-sdk/docs/PACalculationColumn.md new file mode 100644 index 00000000..68855975 --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationColumn.md @@ -0,0 +1,12 @@ +# PACalculationColumn + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | FactSet-defined or User-defined Column identifier. | [optional] +**statistics** | **[str]** | Column Statistic identifier | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACalculationDataSources.md b/auto-generated-sdk/docs/PACalculationDataSources.md new file mode 100644 index 00000000..278a015d --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationDataSources.md @@ -0,0 +1,13 @@ +# PACalculationDataSources + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**portfoliopricingsources** | [**[PACalculationPricingSource]**](PACalculationPricingSource.md) | List of portfilio pricing source for the PA calculation | [optional] +**benchmarkpricingsources** | [**[PACalculationPricingSource]**](PACalculationPricingSource.md) | List of benchmark pricing source for the PA calculation | [optional] +**useportfoliopricingsourcesforbenchmark** | **bool** | Use portfolio pricing sources for benchmark | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACalculationGroup.md b/auto-generated-sdk/docs/PACalculationGroup.md new file mode 100644 index 00000000..3c23cb3a --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationGroup.md @@ -0,0 +1,12 @@ +# PACalculationGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | FactSet-defined or User-defined Group identifier. | [optional] +**frequency** | **str** | Grouping frequency | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACalculationParameters.md b/auto-generated-sdk/docs/PACalculationParameters.md new file mode 100644 index 00000000..d2bc59ab --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationParameters.md @@ -0,0 +1,19 @@ +# PACalculationParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**componentid** | **str** | The PA Engine component identifier to analyze. | +**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts. | [optional] +**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks. | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] +**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] +**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**componentdetail** | **str** | Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACalculationParametersRoot.md b/auto-generated-sdk/docs/PACalculationParametersRoot.md new file mode 100644 index 00000000..8126d6bb --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationParametersRoot.md @@ -0,0 +1,12 @@ +# PACalculationParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (PACalculationParameters,)}**](PACalculationParameters.md) | List of calculation parameters. | [optional] +**meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACalculationPricingSource.md b/auto-generated-sdk/docs/PACalculationPricingSource.md new file mode 100644 index 00000000..47324096 --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationPricingSource.md @@ -0,0 +1,11 @@ +# PACalculationPricingSource + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Pricing source identifier | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACalculationsApi.md b/auto-generated-sdk/docs/PACalculationsApi.md new file mode 100644 index 00000000..6e2fed56 --- /dev/null +++ b/auto-generated-sdk/docs/PACalculationsApi.md @@ -0,0 +1,1098 @@ + +# fds.analyticsapi.engines.PACalculationsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel_calculation_by_id**](PACalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id +[**generate_pa_portfolio_commentary**](PACalculationsApi.md#generate_pa_portfolio_commentary) | **POST** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary | Generate PA portfolio commentary by calculation and unit id. +[**get_all_calculations**](PACalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations +[**get_calculation_parameters**](PACalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id +[**get_calculation_status_by_id**](PACalculationsApi.md#get_calculation_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id +[**get_calculation_unit_result_by_id**](PACalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id +[**get_pa_portfolio_commentary_result_by_id**](PACalculationsApi.md#get_pa_portfolio_commentary_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result | Get PA Portfolio commentary result by calculation and unit id. +[**get_pa_portfolio_commentary_status_by_id**](PACalculationsApi.md#get_pa_portfolio_commentary_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status | Get PA portfolio commentary status by calculation and unit id. +[**post_and_calculate**](PACalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation +[**put_and_calculate**](PACalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. + + +# **cancel_calculation_by_id** +> cancel_calculation_by_id(id) + +Cancel PA calculation by id + +This is the endpoint to cancel a previously submitted calculation. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Create and Run PA calculation endpoint + + # example passing only required values which don't have defaults set + try: + # Cancel PA calculation by id + api_instance.cancel_calculation_by_id(id) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->cancel_calculation_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Create and Run PA calculation endpoint | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: None (empty response body) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Expected response, 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **generate_pa_portfolio_commentary** +> PACommentaryRoot generate_pa_portfolio_commentary(id, unit_id) + +Generate PA portfolio commentary by calculation and unit id. + +This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. Remarks: * The PA component used in the calculation must be an attribution tile. * The \"Variation in Average Weight\" column must be included along with those required as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) in the component for successful commentary generation; otherwise, the request will result in an error. * PA portfolio commentary generation is not supported for multi-port requests. * The POST calculation must use a single portfolio and a benchmark to generate the commentary. * PA portfolio commentary with sub-period analysis will be returned only when the frequency is set to something other than \"single\" and the report contains more than one sub-period. * Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. If the configuration ID is not specified, the default commentary will be returned. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.pa_commentary_get_status_root import PACommentaryGetStatusRoot +from fds.analyticsapi.engines.model.pa_commentary_parameters_root import PACommentaryParametersRoot +from fds.analyticsapi.engines.model.pa_commentary_root import PACommentaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + id = "id_example" # str | Successful calculation id + unit_id = "unitId_example" # str | Unit id associated with the successful calculation id + pa_commentary_parameters_root = PACommentaryParametersRoot( + data=PACommentaryParameters( + configurationid="configurationid_example", + ), + meta=None, + ) # PACommentaryParametersRoot | Request Parameters (optional) + + # example passing only required values which don't have defaults set + try: + # Generate PA portfolio commentary by calculation and unit id. + api_response = api_instance.generate_pa_portfolio_commentary(id, unit_id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->generate_pa_portfolio_commentary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Generate PA portfolio commentary by calculation and unit id. + api_response = api_instance.generate_pa_portfolio_commentary(id, unit_id, pa_commentary_parameters_root=pa_commentary_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->generate_pa_portfolio_commentary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Successful calculation id | + **unit_id** | **str**| Unit id associated with the successful calculation id | + **pa_commentary_parameters_root** | [**PACommentaryParametersRoot**](PACommentaryParametersRoot.md)| Request Parameters | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: (For 201 status - [**PACommentaryRoot**](PACommentaryRoot.md))(For 202 status - [**PACommentaryGetStatusRoot**](PACommentaryGetStatusRoot.md)) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Expected response if the commentary generation is completed in a short span, returns JSON. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting commentary
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_calculations** +> CalculationsSummaryRoot get_all_calculations() + +Get all calculations + +This endpoints returns all calculation requests. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.calculations_summary_root import CalculationsSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + page_number = 1 # int | (optional) if omitted the server will use the default value of 1 + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all calculations + api_response = api_instance.get_all_calculations(page_number=page_number) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->get_all_calculations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page_number** | **int**| | [optional] if omitted the server will use the default value of 1 + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**CalculationsSummaryRoot**](CalculationsSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | List of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid page number. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | No calculation found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_calculation_parameters** +> PACalculationParametersRoot get_calculation_parameters(id) + +Get PA calculation parameters by id + +This is the endpoint that returns the calculation parameters passed for a calculation. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Create and Run PA calculation endpoint + + # example passing only required values which don't have defaults set + try: + # Get PA calculation parameters by id + api_response = api_instance.get_calculation_parameters(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->get_calculation_parameters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Create and Run PA calculation endpoint | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**PACalculationParametersRoot**](PACalculationParametersRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns the PA calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Calculation 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_calculation_status_by_id** +> CalculationStatusRoot get_calculation_status_by_id(id) + +Get PA calculation status by id + +This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the location header will point to the result url. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.calculation_status_root import CalculationStatusRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Create and Run PA calculation endpoint + + # example passing only required values which don't have defaults set + try: + # Get PA calculation status by id + api_response = api_instance.get_calculation_status_by_id(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->get_calculation_status_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Create and Run PA calculation endpoint | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**CalculationStatusRoot**](CalculationStatusRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response once calculation is completed. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_calculation_unit_result_by_id** +> ObjectRoot get_calculation_unit_result_by_id(id, unit_id) + +Get PA calculation result by id + +This is the endpoint to get the result of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.object_root import ObjectRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Get PA calculation status by id endpoint + unit_id = "unitId_example" # str | from url, provided from the location header in the Get PA calculation status by id endpoint + + # example passing only required values which don't have defaults set + try: + # Get PA calculation result by id + api_response = api_instance.get_calculation_unit_result_by_id(id, unit_id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->get_calculation_unit_result_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Get PA calculation status by id endpoint | + **unit_id** | **str**| from url, provided from the location header in the Get PA calculation status by id endpoint | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**ObjectRoot**](ObjectRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/x-protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pa_portfolio_commentary_result_by_id** +> PACommentaryRoot get_pa_portfolio_commentary_result_by_id(id, unit_id) + +Get PA Portfolio commentary result by calculation and unit id. + +This endpoint retrieves the result of a previously requested portfolio commentary. If the commentary generation is complete, the commentary will be returned in a predefined JSON format. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.pa_commentary_root import PACommentaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + id = "id_example" # str | Successful calculation id + unit_id = "unitId_example" # str | Unit id associated with the successful calculation id + + # example passing only required values which don't have defaults set + try: + # Get PA Portfolio commentary result by calculation and unit id. + api_response = api_instance.get_pa_portfolio_commentary_result_by_id(id, unit_id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->get_pa_portfolio_commentary_result_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Successful calculation id | + **unit_id** | **str**| Unit id associated with the successful calculation id | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**PACommentaryRoot**](PACommentaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response once the commentary generation is completed, returns JSON. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pa_portfolio_commentary_status_by_id** +> PACommentaryStatusRoot get_pa_portfolio_commentary_status_by_id(id, unit_id) + +Get PA portfolio commentary status by calculation and unit id. + +This endpoint allows you to check the progress of a previously requested PA portfolio commentary. If the commentary generation is complete, the location header will provide the URL for the result. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.pa_commentary_get_status_root import PACommentaryGetStatusRoot +from fds.analyticsapi.engines.model.pa_commentary_status_root import PACommentaryStatusRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + id = "id_example" # str | Successful calculation id + unit_id = "unitId_example" # str | Unit id associated with the successful calculation id + + # example passing only required values which don't have defaults set + try: + # Get PA portfolio commentary status by calculation and unit id. + api_response = api_instance.get_pa_portfolio_commentary_status_by_id(id, unit_id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->get_pa_portfolio_commentary_status_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Successful calculation id | + **unit_id** | **str**| Unit id associated with the successful calculation id | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: (For 200 status - [**PACommentaryStatusRoot**](PACommentaryStatusRoot.md))(For 202 status - [**PACommentaryGetStatusRoot**](PACommentaryGetStatusRoot.md)) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response once commentary is completed. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**202** | Expected response returned if the commentary generation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_and_calculate** +> CalculationStatusRoot post_and_calculate() + +Create and Run PA calculation + +This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.calculation_status_root import CalculationStatusRoot +from fds.analyticsapi.engines.model.object_root import ObjectRoot +from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) + cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional) + pa_calculation_parameters_root = PACalculationParametersRoot( + data={ + "key": PACalculationParameters( + componentid="componentid_example", + accounts=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + benchmarks=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + dates=PADateParameters( + startdate="startdate_example", + enddate="enddate_example", + frequency="frequency_example", + ), + groups=[ + PACalculationGroup( + id="id_example", + frequency="frequency_example", + ), + ], + currencyisocode="currencyisocode_example", + columns=[ + PACalculationColumn( + id="id_example", + statistics=[ + "statistics_example", + ], + ), + ], + datasources=PACalculationDataSources( + portfoliopricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + benchmarkpricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + useportfoliopricingsourcesforbenchmark=True, + ), + componentdetail="componentdetail_example", + ), + }, + meta=CalculationMeta( + contentorganization="SimplifiedRow", + stach_content_organization="SimplifiedRow", + contenttype="Json", + format="JsonStach", + ), + ) # PACalculationParametersRoot | Calculation Parameters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create and Run PA calculation + api_response = api_instance.post_and_calculate(x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, pa_calculation_parameters_root=pa_calculation_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->post_and_calculate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional] + **cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional] + **pa_calculation_parameters_root** | [**PACalculationParametersRoot**](PACalculationParametersRoot.md)| Calculation Parameters | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: (For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/x-protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **put_and_calculate** +> CalculationStatusRoot put_and_calculate(id) + +Create or Update PA calculation and run it. + +This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pa_calculations_api +from fds.analyticsapi.engines.model.calculation_status_root import CalculationStatusRoot +from fds.analyticsapi.engines.model.object_root import ObjectRoot +from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pa_calculations_api.PACalculationsApi(api_client) + id = "id_example" # str | from url, provided from the location header in the Create and Run PA calculation endpoint + x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation (optional) + cache_control = "Cache-Control_example" # str | Standard HTTP header. Accepts max-stale. (optional) + pa_calculation_parameters_root = PACalculationParametersRoot( + data={ + "key": PACalculationParameters( + componentid="componentid_example", + accounts=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + benchmarks=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + dates=PADateParameters( + startdate="startdate_example", + enddate="enddate_example", + frequency="frequency_example", + ), + groups=[ + PACalculationGroup( + id="id_example", + frequency="frequency_example", + ), + ], + currencyisocode="currencyisocode_example", + columns=[ + PACalculationColumn( + id="id_example", + statistics=[ + "statistics_example", + ], + ), + ], + datasources=PACalculationDataSources( + portfoliopricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + benchmarkpricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + useportfoliopricingsourcesforbenchmark=True, + ), + componentdetail="componentdetail_example", + ), + }, + meta=CalculationMeta( + contentorganization="SimplifiedRow", + stach_content_organization="SimplifiedRow", + contenttype="Json", + format="JsonStach", + ), + ) # PACalculationParametersRoot | Calculation Parameters (optional) + + # example passing only required values which don't have defaults set + try: + # Create or Update PA calculation and run it. + api_response = api_instance.put_and_calculate(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->put_and_calculate: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create or Update PA calculation and run it. + api_response = api_instance.put_and_calculate(id, x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, pa_calculation_parameters_root=pa_calculation_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PACalculationsApi->put_and_calculate: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| from url, provided from the location header in the Create and Run PA calculation endpoint | + **x_fact_set_api_long_running_deadline** | **int**| Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation | [optional] + **cache_control** | **str**| Standard HTTP header. Accepts max-stale. | [optional] + **pa_calculation_parameters_root** | [**PACalculationParametersRoot**](PACalculationParametersRoot.md)| Calculation Parameters | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: (For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md)) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/x-protobuf + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid Calculation Parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/PACommentary.md b/auto-generated-sdk/docs/PACommentary.md new file mode 100644 index 00000000..25d9f9aa --- /dev/null +++ b/auto-generated-sdk/docs/PACommentary.md @@ -0,0 +1,13 @@ +# PACommentary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commentary_id** | **str** | Generated commentary Id | [optional] +**sections** | [**[Section]**](Section.md) | Commentary sections | [optional] +**disclaimer** | **str** | Disclaimer | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md b/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md new file mode 100644 index 00000000..fdd9a428 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md @@ -0,0 +1,12 @@ +# PACommentaryConfigurationSummary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | PA commentary configuration name | [optional] +**directory** | **str** | PA Commentary configuration directory | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md b/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md new file mode 100644 index 00000000..debde525 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md @@ -0,0 +1,12 @@ +# PACommentaryConfigurationSummaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (PACommentaryConfigurationSummary,)}**](PACommentaryConfigurationSummary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryDate.md b/auto-generated-sdk/docs/PACommentaryDate.md new file mode 100644 index 00000000..1a7c0c12 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryDate.md @@ -0,0 +1,12 @@ +# PACommentaryDate + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**yyyymmdd** | **int** | Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time. | [optional] +**relative** | **str** | Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryGetStatus.md b/auto-generated-sdk/docs/PACommentaryGetStatus.md new file mode 100644 index 00000000..f4cf3d49 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryGetStatus.md @@ -0,0 +1,13 @@ +# PACommentaryGetStatus + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**calculationid** | **str** | Calculation id. | [optional] +**unitid** | **str** | Calculation unit id. | [optional] +**status** | **str** | The status of commentary generation. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md b/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md new file mode 100644 index 00000000..77448c9e --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md @@ -0,0 +1,12 @@ +# PACommentaryGetStatusRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PACommentaryGetStatus**](PACommentaryGetStatus.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryParameters.md b/auto-generated-sdk/docs/PACommentaryParameters.md new file mode 100644 index 00000000..57bcb7c1 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryParameters.md @@ -0,0 +1,11 @@ +# PACommentaryParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**configurationid** | **str** | Commentary configuration id | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryParametersRoot.md b/auto-generated-sdk/docs/PACommentaryParametersRoot.md new file mode 100644 index 00000000..b91c8507 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryParametersRoot.md @@ -0,0 +1,12 @@ +# PACommentaryParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PACommentaryParameters**](PACommentaryParameters.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryRoot.md b/auto-generated-sdk/docs/PACommentaryRoot.md new file mode 100644 index 00000000..85cbffc2 --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryRoot.md @@ -0,0 +1,12 @@ +# PACommentaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PACommentary**](PACommentary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryStatus.md b/auto-generated-sdk/docs/PACommentaryStatus.md new file mode 100644 index 00000000..364007aa --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryStatus.md @@ -0,0 +1,14 @@ +# PACommentaryStatus + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | **str** | The result url of the generated commentary. | [optional] +**calculationid** | **str** | Calculation id. | [optional] +**unitid** | **str** | Calculation unit id. | [optional] +**status** | **str** | The status of commentary generation. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryStatusRoot.md b/auto-generated-sdk/docs/PACommentaryStatusRoot.md new file mode 100644 index 00000000..553bffbf --- /dev/null +++ b/auto-generated-sdk/docs/PACommentaryStatusRoot.md @@ -0,0 +1,12 @@ +# PACommentaryStatusRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PACommentaryStatus**](PACommentaryStatus.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PAComponent.md b/auto-generated-sdk/docs/PAComponent.md new file mode 100644 index 00000000..0654c288 --- /dev/null +++ b/auto-generated-sdk/docs/PAComponent.md @@ -0,0 +1,19 @@ +# PAComponent + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Component identifier. | [optional] +**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts saved in the PA document. | [optional] +**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks saved in the PA document. | [optional] +**currencyisocode** | **str** | | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**snapshot** | **bool** | Is the component type snapshot or subperiod. | [optional] +**path** | **str** | The path to the document | [optional] +**name** | **str** | Component name. | [optional] +**category** | **str** | Component category. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PAComponentData.md b/auto-generated-sdk/docs/PAComponentData.md new file mode 100644 index 00000000..24ce86d3 --- /dev/null +++ b/auto-generated-sdk/docs/PAComponentData.md @@ -0,0 +1,18 @@ +# PAComponentData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts. | [optional] +**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks. | [optional] +**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] +**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] +**componentdetail** | **str** | PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PAComponentRoot.md b/auto-generated-sdk/docs/PAComponentRoot.md new file mode 100644 index 00000000..a8a79133 --- /dev/null +++ b/auto-generated-sdk/docs/PAComponentRoot.md @@ -0,0 +1,12 @@ +# PAComponentRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**PAComponent**](PAComponent.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PADateParameters.md b/auto-generated-sdk/docs/PADateParameters.md new file mode 100644 index 00000000..150bd42b --- /dev/null +++ b/auto-generated-sdk/docs/PADateParameters.md @@ -0,0 +1,14 @@ +# PADateParameters + +The date parameters for PA calculation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enddate** | **str** | Calculation's end date. | +**frequency** | **str** | Calculation's frequency. | +**startdate** | **str** | Calculation's start date. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PAIdentifier.md b/auto-generated-sdk/docs/PAIdentifier.md new file mode 100644 index 00000000..c6a97658 --- /dev/null +++ b/auto-generated-sdk/docs/PAIdentifier.md @@ -0,0 +1,12 @@ +# PAIdentifier + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | User's FactSet account path OR benchmark. | +**holdingsmode** | **str** | Holdings Mode can be B&H, TBR, OMS , EXT or VLT. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PAPricingSource.md b/auto-generated-sdk/docs/PAPricingSource.md new file mode 100644 index 00000000..fb4ce976 --- /dev/null +++ b/auto-generated-sdk/docs/PAPricingSource.md @@ -0,0 +1,13 @@ +# PAPricingSource + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Pricing source Name | [optional] +**directory** | **str** | Pricing source directory | [optional] +**category** | **str** | Pricing source category | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PAPricingSourceRoot.md b/auto-generated-sdk/docs/PAPricingSourceRoot.md new file mode 100644 index 00000000..a0e9962a --- /dev/null +++ b/auto-generated-sdk/docs/PAPricingSourceRoot.md @@ -0,0 +1,12 @@ +# PAPricingSourceRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (PAPricingSource,)}**](PAPricingSource.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PaDoc.md b/auto-generated-sdk/docs/PaDoc.md new file mode 100644 index 00000000..c7ddabd9 --- /dev/null +++ b/auto-generated-sdk/docs/PaDoc.md @@ -0,0 +1,11 @@ +# PaDoc + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | PA document path | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PricingSourcesApi.md b/auto-generated-sdk/docs/PricingSourcesApi.md new file mode 100644 index 00000000..4c0668bb --- /dev/null +++ b/auto-generated-sdk/docs/PricingSourcesApi.md @@ -0,0 +1,107 @@ + +# fds.analyticsapi.engines.PricingSourcesApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_pa_pricing_sources**](PricingSourcesApi.md#get_pa_pricing_sources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources + + +# **get_pa_pricing_sources** +> PAPricingSourceRoot get_pa_pricing_sources() + +Get PA pricing sources + +This endpoint lists all the PA pricing sources that can be applied to a PA calculation. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import pricing_sources_api +from fds.analyticsapi.engines.model.pa_pricing_source_root import PAPricingSourceRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pricing_sources_api.PricingSourcesApi(api_client) + name = "" # str | PA pricing sources name (optional) if omitted the server will use the default value of "" + category = "" # str | PA pricing sources category (optional) if omitted the server will use the default value of "" + directory = "" # str | The directory to get the PA pricing sources in (optional) if omitted the server will use the default value of "" + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get PA pricing sources + api_response = api_instance.get_pa_pricing_sources(name=name, category=category, directory=directory) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling PricingSourcesApi->get_pa_pricing_sources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| PA pricing sources name | [optional] if omitted the server will use the default value of "" + **category** | **str**| PA pricing sources category | [optional] if omitted the server will use the default value of "" + **directory** | **str**| The directory to get the PA pricing sources in | [optional] if omitted the server will use the default value of "" + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**PAPricingSourceRoot**](PAPricingSourceRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of PA pricing sources | * X-DataDirect-Request-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 pricing sources list cached response.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Pricing sources not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/Section.md b/auto-generated-sdk/docs/Section.md new file mode 100644 index 00000000..84c6e95a --- /dev/null +++ b/auto-generated-sdk/docs/Section.md @@ -0,0 +1,14 @@ +# Section + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metadata** | [**Metadata**](Metadata.md) | | [optional] +**title** | **str** | Commentary title | [optional] +**content** | **str** | Generated commentary content | [optional] +**sub_sections** | [**[Section]**](Section.md) | Generated commentary subsections | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/StrategyDocumentsApi.md b/auto-generated-sdk/docs/StrategyDocumentsApi.md index 82371efd..1fb0f9eb 100644 --- a/auto-generated-sdk/docs/StrategyDocumentsApi.md +++ b/auto-generated-sdk/docs/StrategyDocumentsApi.md @@ -8,6 +8,7 @@ Method | HTTP request | Description [**get_axioma_equity_strategy_documents**](StrategyDocumentsApi.md#get_axioma_equity_strategy_documents) | **GET** /analytics/engines/axp/v3/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory [**get_axioma_fi_strategy_documents**](StrategyDocumentsApi.md#get_axioma_fi_strategy_documents) | **GET** /analytics/engines/afi/v3/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory [**get_barra_strategy_documents**](StrategyDocumentsApi.md#get_barra_strategy_documents) | **GET** /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory +[**get_fpo_strategy_documents**](StrategyDocumentsApi.md#get_fpo_strategy_documents) | **GET** /analytics/engines/fpo/v3/strategies/{path} | Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory [**get_northfield_strategy_documents**](StrategyDocumentsApi.md#get_northfield_strategy_documents) | **GET** /analytics/engines/npo/v3/strategies/{path} | Get Northfield strategy documents and sub-directories in a directory @@ -287,6 +288,98 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_fpo_strategy_documents** +> DocumentDirectoriesRoot get_fpo_strategy_documents(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 + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import strategy_documents_api +from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = strategy_documents_api.StrategyDocumentsApi(api_client) + path = "Client:" # str | The directory to get the strategy documents and sub-directories in + + # example passing only required values which don't have defaults set + try: + # Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory + api_response = api_instance.get_fpo_strategy_documents(path) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling StrategyDocumentsApi->get_fpo_strategy_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| The directory to get the strategy documents and sub-directories in | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**DocumentDirectoriesRoot**](DocumentDirectoriesRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in 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.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_northfield_strategy_documents** > DocumentDirectoriesRoot get_northfield_strategy_documents(path) diff --git a/auto-generated-sdk/docs/TemplateContentTypes.md b/auto-generated-sdk/docs/TemplateContentTypes.md new file mode 100644 index 00000000..7a747e3d --- /dev/null +++ b/auto-generated-sdk/docs/TemplateContentTypes.md @@ -0,0 +1,13 @@ +# TemplateContentTypes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mandatory** | **[str]** | Template mandatory fields | [optional] +**optional** | **[str]** | Template optional fields | [optional] +**locked** | **[str]** | Template locked fields | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponent.md b/auto-generated-sdk/docs/TemplatedPAComponent.md new file mode 100644 index 00000000..e42c9a06 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponent.md @@ -0,0 +1,18 @@ +# TemplatedPAComponent + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**directory** | **str** | | [optional] +**snapshot** | **bool** | | [optional] +**component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] +**description** | **str** | | [optional] +**name** | **str** | | [optional] +**parent_template_id** | **str** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentParameters.md new file mode 100644 index 00000000..8391fd05 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentParameters.md @@ -0,0 +1,14 @@ +# TemplatedPAComponentParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **str** | Directory to create templated components | +**parent_template_id** | **str** | Parent template id | +**description** | **str** | Component description. | [optional] +**component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md new file mode 100644 index 00000000..aee281d5 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md @@ -0,0 +1,12 @@ +# TemplatedPAComponentParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentParameters**](TemplatedPAComponentParameters.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md new file mode 100644 index 00000000..ad05cdb3 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md @@ -0,0 +1,15 @@ +# TemplatedPAComponentPostSummary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**description** | **str** | | [optional] +**name** | **str** | | [optional] +**parent_template_id** | **str** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md new file mode 100644 index 00000000..781f6e18 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md @@ -0,0 +1,12 @@ +# TemplatedPAComponentPostSummaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentPostSummary**](TemplatedPAComponentPostSummary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentRoot.md new file mode 100644 index 00000000..26ec1284 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentRoot.md @@ -0,0 +1,12 @@ +# TemplatedPAComponentRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponent**](TemplatedPAComponent.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummary.md b/auto-generated-sdk/docs/TemplatedPAComponentSummary.md new file mode 100644 index 00000000..f6f921a0 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentSummary.md @@ -0,0 +1,14 @@ +# TemplatedPAComponentSummary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | | [optional] +**name** | **str** | | [optional] +**parent_template_id** | **str** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md new file mode 100644 index 00000000..0091253b --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md @@ -0,0 +1,12 @@ +# TemplatedPAComponentSummaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (TemplatedPAComponentSummary,)}**](TemplatedPAComponentSummary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md new file mode 100644 index 00000000..f5279b80 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md @@ -0,0 +1,13 @@ +# TemplatedPAComponentUpdateParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parent_template_id** | **str** | Parent template id | [optional] +**description** | **str** | Component description. | [optional] +**component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md new file mode 100644 index 00000000..47a5ae0b --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md @@ -0,0 +1,12 @@ +# TemplatedPAComponentUpdateParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TemplatedPAComponentUpdateParameters**](TemplatedPAComponentUpdateParameters.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/TemplatedPAComponentsApi.md b/auto-generated-sdk/docs/TemplatedPAComponentsApi.md new file mode 100644 index 00000000..9524b269 --- /dev/null +++ b/auto-generated-sdk/docs/TemplatedPAComponentsApi.md @@ -0,0 +1,584 @@ + +# fds.analyticsapi.engines.TemplatedPAComponentsApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_templated_pa_components**](TemplatedPAComponentsApi.md#create_templated_pa_components) | **POST** /analytics/engines/pa/v3/templated-components | Create templated PA component +[**delete_templated_pa_components**](TemplatedPAComponentsApi.md#delete_templated_pa_components) | **DELETE** /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component +[**get_templated_pa_component_by_id**](TemplatedPAComponentsApi.md#get_templated_pa_component_by_id) | **GET** /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id +[**get_templated_pa_components_in_path**](TemplatedPAComponentsApi.md#get_templated_pa_components_in_path) | **GET** /analytics/engines/pa/v3/templated-components | Get templated PA components in path +[**update_templated_pa_components**](TemplatedPAComponentsApi.md#update_templated_pa_components) | **PUT** /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component + + +# **create_templated_pa_components** +> TemplatedPAComponentPostSummaryRoot create_templated_pa_components(templated_pa_component_parameters_root) + +Create templated PA component + +This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import templated_pa_components_api +from fds.analyticsapi.engines.model.templated_pa_component_post_summary_root import TemplatedPAComponentPostSummaryRoot +from fds.analyticsapi.engines.model.templated_pa_component_parameters_root import TemplatedPAComponentParametersRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) + templated_pa_component_parameters_root = TemplatedPAComponentParametersRoot( + data=TemplatedPAComponentParameters( + directory="directory_example", + parent_template_id="parent_template_id_example", + description="description_example", + component_data=PAComponentData( + accounts=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + benchmarks=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + groups=[ + PACalculationGroup( + id="id_example", + frequency="frequency_example", + ), + ], + columns=[ + PACalculationColumn( + id="id_example", + statistics=[ + "statistics_example", + ], + ), + ], + dates=PADateParameters( + startdate="startdate_example", + enddate="enddate_example", + frequency="frequency_example", + ), + datasources=PACalculationDataSources( + portfoliopricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + benchmarkpricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + useportfoliopricingsourcesforbenchmark=True, + ), + currencyisocode="currencyisocode_example", + componentdetail="componentdetail_example", + ), + ), + meta=None, + ) # TemplatedPAComponentParametersRoot | Request Parameters + + # example passing only required values which don't have defaults set + try: + # Create templated PA component + api_response = api_instance.create_templated_pa_components(templated_pa_component_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling TemplatedPAComponentsApi->create_templated_pa_components: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **templated_pa_component_parameters_root** | [**TemplatedPAComponentParametersRoot**](TemplatedPAComponentParametersRoot.md)| Request Parameters | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Expected response, templated PA component created successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_templated_pa_components** +> delete_templated_pa_components(id) + +Delete templated PA component + +This endpoint deletes an existing templated PA component + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import templated_pa_components_api +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for a templated PA component + + # example passing only required values which don't have defaults set + try: + # Delete templated PA component + api_instance.delete_templated_pa_components(id) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling TemplatedPAComponentsApi->delete_templated_pa_components: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for a templated PA component | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: None (empty response body) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Expected response, deleted the templated PA component successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_templated_pa_component_by_id** +> TemplatedPAComponentRoot get_templated_pa_component_by_id(id) + +Get templated PA component by id + +This endpoint fetches the templated PA component settings. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import templated_pa_components_api +from fds.analyticsapi.engines.model.templated_pa_component_root import TemplatedPAComponentRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for a templated PA component + + # example passing only required values which don't have defaults set + try: + # Get templated PA component by id + api_response = api_instance.get_templated_pa_component_by_id(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling TemplatedPAComponentsApi->get_templated_pa_component_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for a templated PA component | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**TemplatedPAComponentRoot**](TemplatedPAComponentRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, templated PA component details. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Templated PA component not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_templated_pa_components_in_path** +> TemplatedPAComponentSummaryRoot get_templated_pa_components_in_path(directory) + +Get templated PA components in path + +This endpoint returns the list of templated PA components in path. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import templated_pa_components_api +from fds.analyticsapi.engines.model.templated_pa_component_summary_root import TemplatedPAComponentSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) + directory = "Personal:TemplatedPAComponents/" # str | Get templated PA components in path + + # example passing only required values which don't have defaults set + try: + # Get templated PA components in path + api_response = api_instance.get_templated_pa_components_in_path(directory) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling TemplatedPAComponentsApi->get_templated_pa_components_in_path: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **directory** | **str**| Get templated PA components in path | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**TemplatedPAComponentSummaryRoot**](TemplatedPAComponentSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list templated PA components. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_templated_pa_components** +> TemplatedPAComponentPostSummaryRoot update_templated_pa_components(id, templated_pa_component_update_parameters_root) + +Update templated PA component + +This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import templated_pa_components_api +from fds.analyticsapi.engines.model.templated_pa_component_post_summary_root import TemplatedPAComponentPostSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.templated_pa_component_update_parameters_root import TemplatedPAComponentUpdateParametersRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = templated_pa_components_api.TemplatedPAComponentsApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for a templated PA component + templated_pa_component_update_parameters_root = TemplatedPAComponentUpdateParametersRoot( + data=TemplatedPAComponentUpdateParameters( + parent_template_id="parent_template_id_example", + description="description_example", + component_data=PAComponentData( + accounts=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + benchmarks=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + groups=[ + PACalculationGroup( + id="id_example", + frequency="frequency_example", + ), + ], + columns=[ + PACalculationColumn( + id="id_example", + statistics=[ + "statistics_example", + ], + ), + ], + dates=PADateParameters( + startdate="startdate_example", + enddate="enddate_example", + frequency="frequency_example", + ), + datasources=PACalculationDataSources( + portfoliopricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + benchmarkpricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + useportfoliopricingsourcesforbenchmark=True, + ), + currencyisocode="currencyisocode_example", + componentdetail="componentdetail_example", + ), + ), + meta=None, + ) # TemplatedPAComponentUpdateParametersRoot | Request Parameters + + # example passing only required values which don't have defaults set + try: + # Update templated PA component + api_response = api_instance.update_templated_pa_components(id, templated_pa_component_update_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling TemplatedPAComponentsApi->update_templated_pa_components: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for a templated PA component | + **templated_pa_component_update_parameters_root** | [**TemplatedPAComponentUpdateParametersRoot**](TemplatedPAComponentUpdateParametersRoot.md)| Request Parameters | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**TemplatedPAComponentPostSummaryRoot**](TemplatedPAComponentPostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, updated successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Component or template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplate.md b/auto-generated-sdk/docs/UnlinkedPATemplate.md new file mode 100644 index 00000000..222c2ce6 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplate.md @@ -0,0 +1,26 @@ +# UnlinkedPATemplate + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Template id. | [optional] +**directory** | **str** | Template directory. | [optional] +**template_type_id** | **str** | Template type id | [optional] +**snapshot** | **bool** | snapshot. | [optional] +**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] +**componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] +**description** | **str** | Template description. | [optional] +**name** | **str** | Template name. | [optional] +**category** | **str** | Unlinked template category | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md new file mode 100644 index 00000000..77d74bc4 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md @@ -0,0 +1,12 @@ +# UnlinkedPATemplateCategoryAndType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category** | **str** | Unlinked template category | [optional] +**name** | **str** | Unlinked template type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md new file mode 100644 index 00000000..cb7e0fdb --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md @@ -0,0 +1,16 @@ +# UnlinkedPATemplateCategoryAndTypeDetails + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Type Id | [optional] +**columns** | [**[UnlinkedPATemplateColumnDetails]**](UnlinkedPATemplateColumnDetails.md) | List of default columns | [optional] +**groups** | [**[UnlinkedPATemplateGroupDetails]**](UnlinkedPATemplateGroupDetails.md) | List of default groupings | [optional] +**snapshot** | **bool** | Snapshot | [optional] +**category** | **str** | Unlinked template category | [optional] +**name** | **str** | Unlinked template type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md new file mode 100644 index 00000000..d2843fff --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md @@ -0,0 +1,12 @@ +# UnlinkedPATemplateCategoryAndTypeDetailsRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateCategoryAndTypeDetails**](UnlinkedPATemplateCategoryAndTypeDetails.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md new file mode 100644 index 00000000..aa32d0f2 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md @@ -0,0 +1,12 @@ +# UnlinkedPATemplateCategoryAndTypeRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (UnlinkedPATemplateCategoryAndType,)}**](UnlinkedPATemplateCategoryAndType.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md new file mode 100644 index 00000000..6e724045 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md @@ -0,0 +1,13 @@ +# UnlinkedPATemplateColumnDetails + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Unlinked template column name | [optional] +**id** | **str** | FactSet-defined or User-defined Column identifier. | [optional] +**statistics** | **[str]** | Column Statistic identifier | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md b/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md new file mode 100644 index 00000000..6e718bb6 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md @@ -0,0 +1,13 @@ +# UnlinkedPATemplateGroupDetails + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Unlinked template group name | [optional] +**id** | **str** | FactSet-defined or User-defined Group identifier. | [optional] +**frequency** | **str** | Grouping frequency | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md new file mode 100644 index 00000000..910d3546 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateParameters.md @@ -0,0 +1,22 @@ +# UnlinkedPATemplateParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**directory** | **str** | The directory to create an unlinked PA template | +**template_type_id** | **str** | Template type id | +**description** | **str** | Template description | [optional] +**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] +**componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md new file mode 100644 index 00000000..cc59019f --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md @@ -0,0 +1,12 @@ +# UnlinkedPATemplateParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateParameters**](UnlinkedPATemplateParameters.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md new file mode 100644 index 00000000..7746062b --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md @@ -0,0 +1,14 @@ +# UnlinkedPATemplatePostSummary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Template id. | [optional] +**description** | **str** | Template description. | [optional] +**name** | **str** | Template name. | [optional] +**category** | **str** | Unlinked template category | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md new file mode 100644 index 00000000..3587cd0a --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md @@ -0,0 +1,12 @@ +# UnlinkedPATemplatePostSummaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplatePostSummary**](UnlinkedPATemplatePostSummary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md new file mode 100644 index 00000000..6f5d01d5 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateRoot.md @@ -0,0 +1,12 @@ +# UnlinkedPATemplateRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplate**](UnlinkedPATemplate.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md new file mode 100644 index 00000000..ac05c7b2 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateSummary.md @@ -0,0 +1,13 @@ +# UnlinkedPATemplateSummary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Template description. | [optional] +**name** | **str** | Template name. | [optional] +**category** | **str** | Unlinked template category | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md new file mode 100644 index 00000000..b198130f --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md @@ -0,0 +1,12 @@ +# UnlinkedPATemplateSummaryRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**{str: (UnlinkedPATemplateSummary,)}**](UnlinkedPATemplateSummary.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md new file mode 100644 index 00000000..73085202 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md @@ -0,0 +1,20 @@ +# UnlinkedPATemplateUpdateParameters + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Template description | [optional] +**accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] +**benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] +**columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] +**dates** | [**PADateParameters**](PADateParameters.md) | | [optional] +**groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] +**datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] +**currencyisocode** | **str** | Currency ISO code for calculation. | [optional] +**componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] +**content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md new file mode 100644 index 00000000..9ab97760 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md @@ -0,0 +1,12 @@ +# UnlinkedPATemplateUpdateParametersRoot + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**UnlinkedPATemplateUpdateParameters**](UnlinkedPATemplateUpdateParameters.md) | | +**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md b/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md new file mode 100644 index 00000000..e88cd7c2 --- /dev/null +++ b/auto-generated-sdk/docs/UnlinkedPATemplatesApi.md @@ -0,0 +1,782 @@ + +# fds.analyticsapi.engines.UnlinkedPATemplatesApi + +All URIs are relative to *https://api.factset.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_unlinked_pa_templates**](UnlinkedPATemplatesApi.md#create_unlinked_pa_templates) | **POST** /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template +[**delete_unlinked_pa_templates**](UnlinkedPATemplatesApi.md#delete_unlinked_pa_templates) | **DELETE** /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template +[**get_default_unlinked_pa_template_types**](UnlinkedPATemplatesApi.md#get_default_unlinked_pa_template_types) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. +[**get_details_type**](UnlinkedPATemplatesApi.md#get_details_type) | **GET** /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. +[**get_unlinked_pa_templates**](UnlinkedPATemplatesApi.md#get_unlinked_pa_templates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates +[**get_unlinked_pa_templates_by_id**](UnlinkedPATemplatesApi.md#get_unlinked_pa_templates_by_id) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id +[**update_unlinked_pa_templates**](UnlinkedPATemplatesApi.md#update_unlinked_pa_templates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template + + +# **create_unlinked_pa_templates** +> UnlinkedPATemplatePostSummaryRoot create_unlinked_pa_templates(unlinked_pa_template_parameters_root) + +Create unlinked PA template + +This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import unlinked_pa_templates_api +from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary_root import UnlinkedPATemplatePostSummaryRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_parameters_root import UnlinkedPATemplateParametersRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) + unlinked_pa_template_parameters_root = UnlinkedPATemplateParametersRoot( + data=UnlinkedPATemplateParameters( + directory="directory_example", + template_type_id="template_type_id_example", + description="description_example", + accounts=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + benchmarks=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + columns=[ + PACalculationColumn( + id="id_example", + statistics=[ + "statistics_example", + ], + ), + ], + dates=PADateParameters( + startdate="startdate_example", + enddate="enddate_example", + frequency="frequency_example", + ), + groups=[ + PACalculationGroup( + id="id_example", + frequency="frequency_example", + ), + ], + datasources=PACalculationDataSources( + portfoliopricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + benchmarkpricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + useportfoliopricingsourcesforbenchmark=True, + ), + currencyisocode="currencyisocode_example", + componentdetail="componentdetail_example", + content=TemplateContentTypes( + mandatory=[ + "mandatory_example", + ], + optional=[ + "optional_example", + ], + locked=[ + "locked_example", + ], + ), + ), + meta=None, + ) # UnlinkedPATemplateParametersRoot | Request Parameters + + # example passing only required values which don't have defaults set + try: + # Create unlinked PA template + api_response = api_instance.create_unlinked_pa_templates(unlinked_pa_template_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling UnlinkedPATemplatesApi->create_unlinked_pa_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **unlinked_pa_template_parameters_root** | [**UnlinkedPATemplateParametersRoot**](UnlinkedPATemplateParametersRoot.md)| Request Parameters | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Expected response, created a unlinked PA template. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_unlinked_pa_templates** +> delete_unlinked_pa_templates(id) + +Delete unlinked PA template + +This endpoint deletes an existing unliked PA template. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import unlinked_pa_templates_api +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for an unlinked PA template + + # example passing only required values which don't have defaults set + try: + # Delete unlinked PA template + api_instance.delete_unlinked_pa_templates(id) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling UnlinkedPATemplatesApi->delete_unlinked_pa_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for an unlinked PA template | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: None (empty response body) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Expected response, deleted the unlinked PA template successfully. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_default_unlinked_pa_template_types** +> UnlinkedPATemplateCategoryAndTypeRoot get_default_unlinked_pa_template_types() + +Get default unlinked PA template types. + +This endpoint fetches default unlinked PA template types. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import unlinked_pa_templates_api +from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_root import UnlinkedPATemplateCategoryAndTypeRoot +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Get default unlinked PA template types. + api_response = api_instance.get_default_unlinked_pa_template_types() + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling UnlinkedPATemplatesApi->get_default_unlinked_pa_template_types: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**UnlinkedPATemplateCategoryAndTypeRoot**](UnlinkedPATemplateCategoryAndTypeRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, default unlinked PA template types | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_details_type** +> UnlinkedPATemplateCategoryAndTypeDetailsRoot get_details_type(id) + +Get unlinked PA template type details by id. + +This endpoint fetches the unlinked PA template type details. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import unlinked_pa_templates_api +from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details_root import UnlinkedPATemplateCategoryAndTypeDetailsRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) + id = "id_example" # str | Unique identifier for an unlinked PA template type + + # example passing only required values which don't have defaults set + try: + # Get unlinked PA template type details by id. + api_response = api_instance.get_details_type(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling UnlinkedPATemplatesApi->get_details_type: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for an unlinked PA template type | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**UnlinkedPATemplateCategoryAndTypeDetailsRoot**](UnlinkedPATemplateCategoryAndTypeDetailsRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, details of the unlinked PA template type | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Unlinked PA template type not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_unlinked_pa_templates** +> UnlinkedPATemplateSummaryRoot get_unlinked_pa_templates() + +Get unlinked PA templates + +This endpoint returns the list of unlinked PA templates. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import unlinked_pa_templates_api +from fds.analyticsapi.engines.model.unlinked_pa_template_summary_root import UnlinkedPATemplateSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) + directory = "Personal:UninkedPATemplates/" # str | Get unlinked PA templates in path. (optional) + category = "Weights" # str | Get unlinked PA templates by category. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get unlinked PA templates + api_response = api_instance.get_unlinked_pa_templates(directory=directory, category=category) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling UnlinkedPATemplatesApi->get_unlinked_pa_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **directory** | **str**| Get unlinked PA templates in path. | [optional] + **category** | **str**| Get unlinked PA templates by category. | [optional] + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**UnlinkedPATemplateSummaryRoot**](UnlinkedPATemplateSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, returns a list of unlinked PA templates. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_unlinked_pa_templates_by_id** +> UnlinkedPATemplateRoot get_unlinked_pa_templates_by_id(id) + +Get unlinked PA template details by id + +This endpoint fetches the template settings. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import unlinked_pa_templates_api +from fds.analyticsapi.engines.model.unlinked_pa_template_root import UnlinkedPATemplateRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for an unlinked PA template + + # example passing only required values which don't have defaults set + try: + # Get unlinked PA template details by id + api_response = api_instance.get_unlinked_pa_templates_by_id(id) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling UnlinkedPATemplatesApi->get_unlinked_pa_templates_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for an unlinked PA template | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**UnlinkedPATemplateRoot**](UnlinkedPATemplateRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, get details of the unlinked PA template. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_unlinked_pa_templates** +> UnlinkedPATemplatePostSummaryRoot update_unlinked_pa_templates(id, unlinked_pa_template_update_parameters_root) + +Update unlinked PA template + +This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. + +### Example + +* Basic Authentication (Basic): +* Bearer Authentication (Bearer): +```python +import time +import fds.analyticsapi.engines +from fds.analyticsapi.engines.api import unlinked_pa_templates_api +from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters_root import UnlinkedPATemplateUpdateParametersRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary_root import UnlinkedPATemplatePostSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from pprint import pprint +# Defining the host is optional and defaults to https://api.factset.com +# See configuration.py for a list of all supported configuration parameters. +configuration = fds.analyticsapi.engines.Configuration( + host = "https://api.factset.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: Basic +configuration = fds.analyticsapi.engines.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure Bearer authorization: Bearer +configuration = fds.analyticsapi.engines.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Enter a context with an instance of the API client +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = unlinked_pa_templates_api.UnlinkedPATemplatesApi(api_client) + id = "01234567890123456789012345678901" # str | Unique identifier for an unlinked PA template + unlinked_pa_template_update_parameters_root = UnlinkedPATemplateUpdateParametersRoot( + data=UnlinkedPATemplateUpdateParameters( + description="description_example", + accounts=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + benchmarks=[ + PAIdentifier( + id="id_example", + holdingsmode="holdingsmode_example", + ), + ], + columns=[ + PACalculationColumn( + id="id_example", + statistics=[ + "statistics_example", + ], + ), + ], + dates=PADateParameters( + startdate="startdate_example", + enddate="enddate_example", + frequency="frequency_example", + ), + groups=[ + PACalculationGroup( + id="id_example", + frequency="frequency_example", + ), + ], + datasources=PACalculationDataSources( + portfoliopricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + benchmarkpricingsources=[ + PACalculationPricingSource( + id="id_example", + ), + ], + useportfoliopricingsourcesforbenchmark=True, + ), + currencyisocode="currencyisocode_example", + componentdetail="componentdetail_example", + content=TemplateContentTypes( + mandatory=[ + "mandatory_example", + ], + optional=[ + "optional_example", + ], + locked=[ + "locked_example", + ], + ), + ), + meta=None, + ) # UnlinkedPATemplateUpdateParametersRoot | Request Parameters + + # example passing only required values which don't have defaults set + try: + # Update unlinked PA template + api_response = api_instance.update_unlinked_pa_templates(id, unlinked_pa_template_update_parameters_root) + pprint(api_response) + except fds.analyticsapi.engines.ApiException as e: + print("Exception when calling UnlinkedPATemplatesApi->update_unlinked_pa_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Unique identifier for an unlinked PA template | + **unlinked_pa_template_update_parameters_root** | [**UnlinkedPATemplateUpdateParametersRoot**](UnlinkedPATemplateUpdateParametersRoot.md)| Request Parameters | + +### Return type + + - A tuple with response data, HTTP status code and response headers. + - **Response datatype**: [**UnlinkedPATemplatePostSummaryRoot**](UnlinkedPATemplatePostSummaryRoot.md) + +### Authorization + +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Expected response, updated the unlinked PA template. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**400** | Invalid data provided. Please check the request parameters before attempting again. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py new file mode 100644 index 00000000..e5721526 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py @@ -0,0 +1,146 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot + + +class ColumnStatisticsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __get_pa_column_statistics( + self, + **kwargs + ): + """Get PA column statistics # noqa: E501 + + This endpoint lists all the column statistics that can be applied to a PA column. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_column_statistics(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ColumnStatisticRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_pa_column_statistics = _Endpoint( + settings={ + 'response_type': dict({ 200:(ColumnStatisticRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/columnstatistics', + 'operation_id': 'get_pa_column_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_column_statistics + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py new file mode 100644 index 00000000..05991551 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py @@ -0,0 +1,286 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.column_root import ColumnRoot +from fds.analyticsapi.engines.model.column_summary_root import ColumnSummaryRoot + + +class ColumnsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __get_pa_column_by_id( + self, + id, + **kwargs + ): + """Get PA column settings # noqa: E501 + + This endpoint returns the default settings of a PA column. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_column_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for a column + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ColumnRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_pa_column_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(ColumnRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/columns/{id}', + 'operation_id': 'get_pa_column_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_column_by_id + ) + + def __get_pa_columns( + self, + **kwargs + ): + """Get PA columns # noqa: E501 + + This endpoint lists all the PA columns that can be applied to a calculation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_columns(async_req=True) + >>> result = thread.get() + + + Keyword Args: + name (str): Column name. [optional] if omitted the server will use the default value of "" + category (str): Column category. [optional] if omitted the server will use the default value of "" + directory (str): The directory to get the columns in. [optional] if omitted the server will use the default value of "" + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ColumnSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_pa_columns = _Endpoint( + settings={ + 'response_type': dict({ 200:(ColumnSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/columns', + 'operation_id': 'get_pa_columns', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'name', + 'category', + 'directory', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'name': + (str,), + 'category': + (str,), + 'directory': + (str,), + }, + 'attribute_map': { + 'name': 'name', + 'category': 'category', + 'directory': 'directory', + }, + 'location_map': { + 'name': 'query', + 'category': 'query', + 'directory': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_columns + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py index 88d37741..5f3c3984 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py @@ -24,6 +24,7 @@ ) from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.component_summary_root import ComponentSummaryRoot +from fds.analyticsapi.engines.model.pa_component_root import PAComponentRoot from fds.analyticsapi.engines.model.spar_component_root import SPARComponentRoot from fds.analyticsapi.engines.model.vault_component_root import VaultComponentRoot @@ -40,6 +41,246 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client + def __get_pa_component_by_id( + self, + id, + **kwargs + ): + """Get PA component by id # noqa: E501 + + This endpoint returns the default settings of a PA component. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_component_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for a PA component + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + PAComponentRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_pa_component_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(PAComponentRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/components/{id}', + 'operation_id': 'get_pa_component_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_component_by_id + ) + + def __get_pa_components( + self, + document, + **kwargs + ): + """Get PA components # noqa: E501 + + This endpoint returns the list of PA components in a given PA document. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_components(document, async_req=True) + >>> result = thread.get() + + Args: + document (str): Document Name + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ComponentSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['document'] = \ + document + return self.call_with_http_info(**kwargs) + + self.get_pa_components = _Endpoint( + settings={ + 'response_type': dict({ 200:(ComponentSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/components', + 'operation_id': 'get_pa_components', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'document', + ], + 'required': [ + 'document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'document': + (str,), + }, + 'attribute_map': { + 'document': 'document', + }, + 'location_map': { + 'document': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_components + ) + def __get_spar_component_by_id( self, id, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py index 25483ab0..1fa50663 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py @@ -23,6 +23,7 @@ validate_and_convert_types ) from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.pa_commentary_configuration_summary_root import PACommentaryConfigurationSummaryRoot from fds.analyticsapi.engines.model.vault_configuration_root import VaultConfigurationRoot from fds.analyticsapi.engines.model.vault_configuration_summary_root import VaultConfigurationSummaryRoot @@ -39,6 +40,126 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client + def __get_pa_commentary_configurations( + self, + path, + **kwargs + ): + """Get PA commentary configurations in a directory # noqa: E501 + + This endpoint returns all PA commentary configurations in a given directory. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_commentary_configurations(path, async_req=True) + >>> result = thread.get() + + Args: + path (str): The directory to get the PA commentary configurations + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + PACommentaryConfigurationSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['path'] = \ + path + return self.call_with_http_info(**kwargs) + + self.get_pa_commentary_configurations = _Endpoint( + settings={ + 'response_type': dict({ 200:(PACommentaryConfigurationSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/commentary/configurations', + 'operation_id': 'get_pa_commentary_configurations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'path', + ], + 'required': [ + 'path', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'path': + (str,), + }, + 'attribute_map': { + 'path': 'path', + }, + 'location_map': { + 'path': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_commentary_configurations + ) + def __get_vault_configuration_by_id( self, id, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py index 65a72e48..b73c6dd8 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py @@ -38,6 +38,152 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client + def __convert_pa_dates_to_absolute_format( + self, + enddate, + componentid, + account, + **kwargs + ): + """Convert PA dates to absolute format # noqa: E501 + + 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. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.convert_pa_dates_to_absolute_format(enddate, componentid, account, async_req=True) + >>> result = thread.get() + + Args: + enddate (str): End Date + componentid (str): Component Id + account (str): Account ( Account Name ending with .ACCT or .ACTM ) + + Keyword Args: + startdate (str): Start Date. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DateParametersSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['enddate'] = \ + enddate + kwargs['componentid'] = \ + componentid + kwargs['account'] = \ + account + return self.call_with_http_info(**kwargs) + + self.convert_pa_dates_to_absolute_format = _Endpoint( + settings={ + 'response_type': dict({ 200:(DateParametersSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/dates', + 'operation_id': 'convert_pa_dates_to_absolute_format', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'enddate', + 'componentid', + 'account', + 'startdate', + ], + 'required': [ + 'enddate', + 'componentid', + 'account', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'enddate': + (str,), + 'componentid': + (str,), + 'account': + (str,), + 'startdate': + (str,), + }, + 'attribute_map': { + 'enddate': 'enddate', + 'componentid': 'componentid', + 'account': 'account', + 'startdate': 'startdate', + }, + 'location_map': { + 'enddate': 'query', + 'componentid': 'query', + 'account': 'query', + 'startdate': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__convert_pa_dates_to_absolute_format + ) + def __convert_vault_dates_to_absolute_format( self, enddate, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py index 449a6d32..89e90dd8 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py @@ -38,6 +38,126 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client + def __get_pa3_documents( + self, + path, + **kwargs + ): + """Get PA3 documents and sub-directories in a directory # noqa: E501 + + This endpoint looks up all PA3 documents and sub-directories in a given directory. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa3_documents(path, async_req=True) + >>> result = thread.get() + + Args: + path (str): The directory to get the documents and sub-directories in + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DocumentDirectoriesRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['path'] = \ + path + return self.call_with_http_info(**kwargs) + + self.get_pa3_documents = _Endpoint( + settings={ + 'response_type': dict({ 200:(DocumentDirectoriesRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/documents/{path}', + 'operation_id': 'get_pa3_documents', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'path', + ], + 'required': [ + 'path', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'path': + (str,), + }, + 'attribute_map': { + 'path': 'path', + }, + 'location_map': { + 'path': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa3_documents + ) + def __get_pub_documents( self, path, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py new file mode 100644 index 00000000..1ab4b386 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py @@ -0,0 +1,795 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.calculation_info_root import CalculationInfoRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot +from fds.analyticsapi.engines.model.object_root import ObjectRoot + + +class FPOOptimizerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __cancel_optimization_by_id( + self, + id, + **kwargs + ): + """Cancel FPO optimization by id # noqa: E501 + + This is the endpoint to cancel a previously submitted optimization. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.cancel_optimization_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Create and Run FPO optimization endpoint + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.cancel_optimization_by_id = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}', + 'operation_id': 'cancel_optimization_by_id', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/plain', + 'application/json', + 'text/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__cancel_optimization_by_id + ) + + def __get_optimization_parameters( + self, + id, + **kwargs + ): + """Get FPO optimization parameters by id # noqa: E501 + + This is the endpoint that returns the optimization parameters passed for an optimization. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_optimization_parameters(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Create and Run FPO optimization endpoint + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + FPOOptimizationParametersRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_optimization_parameters = _Endpoint( + settings={ + 'response_type': dict({ 200:(FPOOptimizationParametersRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}', + 'operation_id': 'get_optimization_parameters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_optimization_parameters + ) + + def __get_optimization_result( + self, + id, + **kwargs + ): + """Get FPO optimization result by id # noqa: E501 + + This is the endpoint to get the result of a previously requested optimization. If the optimization has finished computing, the body of the response will contain result in JSON. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_optimization_result(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Get FPO optimization status by id endpoint + + Keyword Args: + accept (str): Standard HTTP header. Value can be gzip, compress, deflate, br, identity and/or *. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ObjectRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_optimization_result = _Endpoint( + settings={ + 'response_type': dict({ 200:(ObjectRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}/result', + 'operation_id': 'get_optimization_result', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'accept', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'accept': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'accept': 'Accept', + }, + 'location_map': { + 'id': 'path', + 'accept': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_optimization_result + ) + + def __get_optimization_status_by_id( + self, + id, + **kwargs + ): + """Get FPO optimization status by id # noqa: E501 + + 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. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_optimization_status_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Create and Run FPO optimization endpoint + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + (For 201 status - ObjectRoot)(For 202 status - None) + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_optimization_status_by_id = _Endpoint( + settings={ + 'response_type': dict({ 201:(ObjectRoot,), 202:None, }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}/status', + 'operation_id': 'get_optimization_status_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_optimization_status_by_id + ) + + def __post_and_optimize( + self, + **kwargs + ): + """Create and Run FPO optimization # noqa: E501 + + This endpoint runs FPO optimization specified in the POST body parameters. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the strategy document. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.post_and_optimize(async_req=True) + >>> result = thread.get() + + + Keyword Args: + x_fact_set_api_long_running_deadline (int): Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.. [optional] + cache_control (str): Standard HTTP header. Accepts max-stale.. [optional] + fpo_optimization_parameters_root (FPOOptimizationParametersRoot): Optimization Parameters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.post_and_optimize = _Endpoint( + settings={ + 'response_type': dict({ 202:(CalculationInfoRoot,), 201:(ObjectRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/fpo/v3/optimizations', + 'operation_id': 'post_and_optimize', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'x_fact_set_api_long_running_deadline', + 'cache_control', + 'fpo_optimization_parameters_root', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'x_fact_set_api_long_running_deadline': + (int,), + 'cache_control': + (str,), + 'fpo_optimization_parameters_root': + (FPOOptimizationParametersRoot,), + }, + 'attribute_map': { + 'x_fact_set_api_long_running_deadline': 'X-FactSet-Api-Long-Running-Deadline', + 'cache_control': 'Cache-Control', + }, + 'location_map': { + 'x_fact_set_api_long_running_deadline': 'header', + 'cache_control': 'header', + 'fpo_optimization_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__post_and_optimize + ) + + def __put_and_optimize( + self, + id, + **kwargs + ): + """Create or Update FPO optimization and run it. # noqa: E501 + + This endpoint updates and run the FPO optimization specified in the PUT body parameters. It also allows the creation of new FPO optimization with custom id. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.put_and_optimize(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Create and Run FPO optimization endpoint + + Keyword Args: + x_fact_set_api_long_running_deadline (int): Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.. [optional] + cache_control (str): Standard HTTP header. Accepts max-stale.. [optional] + fpo_optimization_parameters_root (FPOOptimizationParametersRoot): Optimization Parameters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot) + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.put_and_optimize = _Endpoint( + settings={ + 'response_type': dict({ 202:(CalculationInfoRoot,), 201:(ObjectRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/fpo/v3/optimizations/{id}', + 'operation_id': 'put_and_optimize', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'x_fact_set_api_long_running_deadline', + 'cache_control', + 'fpo_optimization_parameters_root', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'x_fact_set_api_long_running_deadline': + (int,), + 'cache_control': + (str,), + 'fpo_optimization_parameters_root': + (FPOOptimizationParametersRoot,), + }, + 'attribute_map': { + 'id': 'id', + 'x_fact_set_api_long_running_deadline': 'X-FactSet-Api-Long-Running-Deadline', + 'cache_control': 'Cache-Control', + }, + 'location_map': { + 'id': 'path', + 'x_fact_set_api_long_running_deadline': 'header', + 'cache_control': 'header', + 'fpo_optimization_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__put_and_optimize + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py index 114cb700..e8047224 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py @@ -37,6 +37,114 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client + def __get_pa_frequencies( + self, + **kwargs + ): + """Get PA frequencies # noqa: E501 + + This endpoint lists all the frequencies that can be applied to a PA calculation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_frequencies(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + FrequencyRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_pa_frequencies = _Endpoint( + settings={ + 'response_type': dict({ 200:(FrequencyRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/frequencies', + 'operation_id': 'get_pa_frequencies', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_frequencies + ) + def __get_spar_frequencies( self, **kwargs diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py new file mode 100644 index 00000000..3b201e16 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py @@ -0,0 +1,255 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot +from fds.analyticsapi.engines.model.group_root import GroupRoot + + +class GroupsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __get_pa_grouping_frequencies( + self, + **kwargs + ): + """Get PA grouping frequencies # noqa: E501 + + This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_grouping_frequencies(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + FrequencyRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_pa_grouping_frequencies = _Endpoint( + settings={ + 'response_type': dict({ 200:(FrequencyRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/grouping-frequencies', + 'operation_id': 'get_pa_grouping_frequencies', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_grouping_frequencies + ) + + def __get_pa_groups( + self, + **kwargs + ): + """Get PA groups # noqa: E501 + + This endpoint lists all the PA groups that can be applied to a PA calculation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_groups(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GroupRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_pa_groups = _Endpoint( + settings={ + 'response_type': dict({ 200:(GroupRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/groups', + 'operation_id': 'get_pa_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_groups + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py new file mode 100644 index 00000000..66764fad --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py @@ -0,0 +1,661 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.linked_pa_template_parameters_root import LinkedPATemplateParametersRoot +from fds.analyticsapi.engines.model.linked_pa_template_post_summary_root import LinkedPATemplatePostSummaryRoot +from fds.analyticsapi.engines.model.linked_pa_template_root import LinkedPATemplateRoot +from fds.analyticsapi.engines.model.linked_pa_template_summary_root import LinkedPATemplateSummaryRoot +from fds.analyticsapi.engines.model.linked_pa_template_update_parameters_root import LinkedPATemplateUpdateParametersRoot + + +class LinkedPATemplatesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __create_linked_pa_templates( + self, + linked_pa_template_parameters_root, + **kwargs + ): + """Create a linked PA template # noqa: E501 + + This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_linked_pa_templates(linked_pa_template_parameters_root, async_req=True) + >>> result = thread.get() + + Args: + linked_pa_template_parameters_root (LinkedPATemplateParametersRoot): Request Parameters + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + LinkedPATemplatePostSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['linked_pa_template_parameters_root'] = \ + linked_pa_template_parameters_root + return self.call_with_http_info(**kwargs) + + self.create_linked_pa_templates = _Endpoint( + settings={ + 'response_type': dict({ 201:(LinkedPATemplatePostSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/linked-templates', + 'operation_id': 'create_linked_pa_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'linked_pa_template_parameters_root', + ], + 'required': [ + 'linked_pa_template_parameters_root', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'linked_pa_template_parameters_root': + (LinkedPATemplateParametersRoot,), + }, + 'attribute_map': { + }, + 'location_map': { + 'linked_pa_template_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__create_linked_pa_templates + ) + + def __delete_linked_pa_templates( + self, + id, + **kwargs + ): + """Delete a linked PA template. # noqa: E501 + + This endpoint deletes an existing linked PA template. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_linked_pa_templates(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for a linked PA template + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.delete_linked_pa_templates = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/linked-templates/{id}', + 'operation_id': 'delete_linked_pa_templates', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__delete_linked_pa_templates + ) + + def __get_linked_pa_templates( + self, + **kwargs + ): + """Get linked PA templates # noqa: E501 + + This endpoint returns the list of linked PA templates in given path. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_linked_pa_templates(async_req=True) + >>> result = thread.get() + + + Keyword Args: + directory (str): Get linked PA templates in path.. [optional] + document_directory (str): Get linked PA templates for documents in document path. [optional] + document_name (str): Get linked PA templates for documents by document name. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + LinkedPATemplateSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_linked_pa_templates = _Endpoint( + settings={ + 'response_type': dict({ 200:(LinkedPATemplateSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/linked-templates', + 'operation_id': 'get_linked_pa_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'directory', + 'document_directory', + 'document_name', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'directory': + (str,), + 'document_directory': + (str,), + 'document_name': + (str,), + }, + 'attribute_map': { + 'directory': 'directory', + 'document_directory': 'documentDirectory', + 'document_name': 'documentName', + }, + 'location_map': { + 'directory': 'query', + 'document_directory': 'query', + 'document_name': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_linked_pa_templates + ) + + def __get_linked_pa_templates_by_id( + self, + id, + **kwargs + ): + """Get linked PA template by id # noqa: E501 + + This endpoint fetches the linked PA template settings. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_linked_pa_templates_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for a linked PA template + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + LinkedPATemplateRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_linked_pa_templates_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(LinkedPATemplateRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/linked-templates/{id}', + 'operation_id': 'get_linked_pa_templates_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_linked_pa_templates_by_id + ) + + def __update_linked_pa_templates( + self, + id, + linked_pa_template_update_parameters_root, + **kwargs + ): + """Update a linked PA template # noqa: E501 + + This endpoint allows the user to change the request body and description from an existing template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Multi-horizon frequencies are not supported through this endpoint. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_linked_pa_templates(id, linked_pa_template_update_parameters_root, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for a linked PA template + linked_pa_template_update_parameters_root (LinkedPATemplateUpdateParametersRoot): Request Parameters + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + LinkedPATemplatePostSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['linked_pa_template_update_parameters_root'] = \ + linked_pa_template_update_parameters_root + return self.call_with_http_info(**kwargs) + + self.update_linked_pa_templates = _Endpoint( + settings={ + 'response_type': dict({ 200:(LinkedPATemplatePostSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/linked-templates/{id}', + 'operation_id': 'update_linked_pa_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'linked_pa_template_update_parameters_root', + ], + 'required': [ + 'id', + 'linked_pa_template_update_parameters_root', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'linked_pa_template_update_parameters_root': + (LinkedPATemplateUpdateParametersRoot,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'linked_pa_template_update_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__update_linked_pa_templates + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py new file mode 100644 index 00000000..277bae14 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py @@ -0,0 +1,1316 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.calculation_status_root import CalculationStatusRoot +from fds.analyticsapi.engines.model.calculations_summary_root import CalculationsSummaryRoot +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.object_root import ObjectRoot +from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot +from fds.analyticsapi.engines.model.pa_commentary_get_status_root import PACommentaryGetStatusRoot +from fds.analyticsapi.engines.model.pa_commentary_parameters_root import PACommentaryParametersRoot +from fds.analyticsapi.engines.model.pa_commentary_root import PACommentaryRoot +from fds.analyticsapi.engines.model.pa_commentary_status_root import PACommentaryStatusRoot + + +class PACalculationsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __cancel_calculation_by_id( + self, + id, + **kwargs + ): + """Cancel PA calculation by id # noqa: E501 + + This is the endpoint to cancel a previously submitted calculation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.cancel_calculation_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Create and Run PA calculation endpoint + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.cancel_calculation_by_id = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}', + 'operation_id': 'cancel_calculation_by_id', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__cancel_calculation_by_id + ) + + def __generate_pa_portfolio_commentary( + self, + id, + unit_id, + **kwargs + ): + """Generate PA portfolio commentary by calculation and unit id. # noqa: E501 + + This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. Remarks: * The PA component used in the calculation must be an attribution tile. * The \"Variation in Average Weight\" column must be included along with those required as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) in the component for successful commentary generation; otherwise, the request will result in an error. * PA portfolio commentary generation is not supported for multi-port requests. * The POST calculation must use a single portfolio and a benchmark to generate the commentary. * PA portfolio commentary with sub-period analysis will be returned only when the frequency is set to something other than \"single\" and the report contains more than one sub-period. * Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. If the configuration ID is not specified, the default commentary will be returned. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.generate_pa_portfolio_commentary(id, unit_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Successful calculation id + unit_id (str): Unit id associated with the successful calculation id + + Keyword Args: + pa_commentary_parameters_root (PACommentaryParametersRoot): Request Parameters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + (For 201 status - PACommentaryRoot)(For 202 status - PACommentaryGetStatusRoot) + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['unit_id'] = \ + unit_id + return self.call_with_http_info(**kwargs) + + self.generate_pa_portfolio_commentary = _Endpoint( + settings={ + 'response_type': dict({ 201:(PACommentaryRoot,), 202:(PACommentaryGetStatusRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary', + 'operation_id': 'generate_pa_portfolio_commentary', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'unit_id', + 'pa_commentary_parameters_root', + ], + 'required': [ + 'id', + 'unit_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'unit_id': + (str,), + 'pa_commentary_parameters_root': + (PACommentaryParametersRoot,), + }, + 'attribute_map': { + 'id': 'id', + 'unit_id': 'unitId', + }, + 'location_map': { + 'id': 'path', + 'unit_id': 'path', + 'pa_commentary_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__generate_pa_portfolio_commentary + ) + + def __get_all_calculations( + self, + **kwargs + ): + """Get all calculations # noqa: E501 + + This endpoints returns all calculation requests. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_calculations(async_req=True) + >>> result = thread.get() + + + Keyword Args: + page_number (int): [optional] if omitted the server will use the default value of 1 + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CalculationsSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_all_calculations = _Endpoint( + settings={ + 'response_type': dict({ 200:(CalculationsSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations', + 'operation_id': 'get_all_calculations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'page_number', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'page_number': + (int,), + }, + 'attribute_map': { + 'page_number': 'pageNumber', + }, + 'location_map': { + 'page_number': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_all_calculations + ) + + def __get_calculation_parameters( + self, + id, + **kwargs + ): + """Get PA calculation parameters by id # noqa: E501 + + This is the endpoint that returns the calculation parameters passed for a calculation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_calculation_parameters(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Create and Run PA calculation endpoint + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + PACalculationParametersRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_calculation_parameters = _Endpoint( + settings={ + 'response_type': dict({ 200:(PACalculationParametersRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}', + 'operation_id': 'get_calculation_parameters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_calculation_parameters + ) + + def __get_calculation_status_by_id( + self, + id, + **kwargs + ): + """Get PA calculation status by id # noqa: E501 + + This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the location header will point to the result url. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_calculation_status_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Create and Run PA calculation endpoint + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CalculationStatusRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_calculation_status_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(CalculationStatusRoot,), 202:(CalculationStatusRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/status', + 'operation_id': 'get_calculation_status_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_calculation_status_by_id + ) + + def __get_calculation_unit_result_by_id( + self, + id, + unit_id, + **kwargs + ): + """Get PA calculation result by id # noqa: E501 + + This is the endpoint to get the result of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_calculation_unit_result_by_id(id, unit_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Get PA calculation status by id endpoint + unit_id (str): from url, provided from the location header in the Get PA calculation status by id endpoint + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ObjectRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['unit_id'] = \ + unit_id + return self.call_with_http_info(**kwargs) + + self.get_calculation_unit_result_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(ObjectRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result', + 'operation_id': 'get_calculation_unit_result_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'unit_id', + ], + 'required': [ + 'id', + 'unit_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'unit_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'unit_id': 'unitId', + }, + 'location_map': { + 'id': 'path', + 'unit_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/x-protobuf' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_calculation_unit_result_by_id + ) + + def __get_pa_portfolio_commentary_result_by_id( + self, + id, + unit_id, + **kwargs + ): + """Get PA Portfolio commentary result by calculation and unit id. # noqa: E501 + + This endpoint retrieves the result of a previously requested portfolio commentary. If the commentary generation is complete, the commentary will be returned in a predefined JSON format. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_portfolio_commentary_result_by_id(id, unit_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Successful calculation id + unit_id (str): Unit id associated with the successful calculation id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + PACommentaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['unit_id'] = \ + unit_id + return self.call_with_http_info(**kwargs) + + self.get_pa_portfolio_commentary_result_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(PACommentaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result', + 'operation_id': 'get_pa_portfolio_commentary_result_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'unit_id', + ], + 'required': [ + 'id', + 'unit_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'unit_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'unit_id': 'unitId', + }, + 'location_map': { + 'id': 'path', + 'unit_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_portfolio_commentary_result_by_id + ) + + def __get_pa_portfolio_commentary_status_by_id( + self, + id, + unit_id, + **kwargs + ): + """Get PA portfolio commentary status by calculation and unit id. # noqa: E501 + + This endpoint allows you to check the progress of a previously requested PA portfolio commentary. If the commentary generation is complete, the location header will provide the URL for the result. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_portfolio_commentary_status_by_id(id, unit_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Successful calculation id + unit_id (str): Unit id associated with the successful calculation id + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + (For 200 status - PACommentaryStatusRoot)(For 202 status - PACommentaryGetStatusRoot) + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['unit_id'] = \ + unit_id + return self.call_with_http_info(**kwargs) + + self.get_pa_portfolio_commentary_status_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(PACommentaryStatusRoot,), 202:(PACommentaryGetStatusRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status', + 'operation_id': 'get_pa_portfolio_commentary_status_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'unit_id', + ], + 'required': [ + 'id', + 'unit_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'unit_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'unit_id': 'unitId', + }, + 'location_map': { + 'id': 'path', + 'unit_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_portfolio_commentary_status_by_id + ) + + def __post_and_calculate( + self, + **kwargs + ): + """Create and Run PA calculation # noqa: E501 + + This endpoint runs the PA calculation specified in the POST body parameters. It can take one or more calculation units as input. Remarks: * Any settings in POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.post_and_calculate(async_req=True) + >>> result = thread.get() + + + Keyword Args: + x_fact_set_api_long_running_deadline (int): Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.. [optional] + cache_control (str): Standard HTTP header. Accepts max-stale.. [optional] + pa_calculation_parameters_root (PACalculationParametersRoot): Calculation Parameters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + (For 202 status - CalculationStatusRoot)(For 201 status - ObjectRoot)(For 200 status - CalculationStatusRoot) + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.post_and_calculate = _Endpoint( + settings={ + 'response_type': dict({ 202:(CalculationStatusRoot,), 201:(ObjectRoot,), 200:(CalculationStatusRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations', + 'operation_id': 'post_and_calculate', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'x_fact_set_api_long_running_deadline', + 'cache_control', + 'pa_calculation_parameters_root', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'x_fact_set_api_long_running_deadline': + (int,), + 'cache_control': + (str,), + 'pa_calculation_parameters_root': + (PACalculationParametersRoot,), + }, + 'attribute_map': { + 'x_fact_set_api_long_running_deadline': 'X-FactSet-Api-Long-Running-Deadline', + 'cache_control': 'Cache-Control', + }, + 'location_map': { + 'x_fact_set_api_long_running_deadline': 'header', + 'cache_control': 'header', + 'pa_calculation_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/x-protobuf' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__post_and_calculate + ) + + def __put_and_calculate( + self, + id, + **kwargs + ): + """Create or Update PA calculation and run it. # noqa: E501 + + This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids. It can take one or more calculation units as input. Remarks: * Any settings in PUT body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.put_and_calculate(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): from url, provided from the location header in the Create and Run PA calculation endpoint + + Keyword Args: + x_fact_set_api_long_running_deadline (int): Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. [optional] + cache_control (str): Standard HTTP header. Accepts max-stale.. [optional] + pa_calculation_parameters_root (PACalculationParametersRoot): Calculation Parameters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - ObjectRoot) + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.put_and_calculate = _Endpoint( + settings={ + 'response_type': dict({ 202:(CalculationStatusRoot,), 200:(CalculationStatusRoot,), 201:(ObjectRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}', + 'operation_id': 'put_and_calculate', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'x_fact_set_api_long_running_deadline', + 'cache_control', + 'pa_calculation_parameters_root', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'x_fact_set_api_long_running_deadline': + (int,), + 'cache_control': + (str,), + 'pa_calculation_parameters_root': + (PACalculationParametersRoot,), + }, + 'attribute_map': { + 'id': 'id', + 'x_fact_set_api_long_running_deadline': 'X-FactSet-Api-Long-Running-Deadline', + 'cache_control': 'Cache-Control', + }, + 'location_map': { + 'id': 'path', + 'x_fact_set_api_long_running_deadline': 'header', + 'cache_control': 'header', + 'pa_calculation_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/x-protobuf' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__put_and_calculate + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py new file mode 100644 index 00000000..45213727 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py @@ -0,0 +1,165 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.pa_pricing_source_root import PAPricingSourceRoot + + +class PricingSourcesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __get_pa_pricing_sources( + self, + **kwargs + ): + """Get PA pricing sources # noqa: E501 + + This endpoint lists all the PA pricing sources that can be applied to a PA calculation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_pa_pricing_sources(async_req=True) + >>> result = thread.get() + + + Keyword Args: + name (str): PA pricing sources name. [optional] if omitted the server will use the default value of "" + category (str): PA pricing sources category. [optional] if omitted the server will use the default value of "" + directory (str): The directory to get the PA pricing sources in. [optional] if omitted the server will use the default value of "" + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + PAPricingSourceRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_pa_pricing_sources = _Endpoint( + settings={ + 'response_type': dict({ 200:(PAPricingSourceRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/pricing-sources', + 'operation_id': 'get_pa_pricing_sources', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'name', + 'category', + 'directory', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'name': + (str,), + 'category': + (str,), + 'directory': + (str,), + }, + 'attribute_map': { + 'name': 'name', + 'category': 'category', + 'directory': 'directory', + }, + 'location_map': { + 'name': 'query', + 'category': 'query', + 'directory': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_pa_pricing_sources + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py index 715f5c10..4934bd50 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py @@ -398,6 +398,126 @@ def __get_barra_strategy_documents( callable=__get_barra_strategy_documents ) + def __get_fpo_strategy_documents( + self, + path, + **kwargs + ): + """Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory # noqa: E501 + + This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_fpo_strategy_documents(path, async_req=True) + >>> result = thread.get() + + Args: + path (str): The directory to get the strategy documents and sub-directories in + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DocumentDirectoriesRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['path'] = \ + path + return self.call_with_http_info(**kwargs) + + self.get_fpo_strategy_documents = _Endpoint( + settings={ + 'response_type': dict({ 200:(DocumentDirectoriesRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/fpo/v3/strategies/{path}', + 'operation_id': 'get_fpo_strategy_documents', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'path', + ], + 'required': [ + 'path', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'path': + (str,), + }, + 'attribute_map': { + 'path': 'path', + }, + 'location_map': { + 'path': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_fpo_strategy_documents + ) + def __get_northfield_strategy_documents( self, path, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py new file mode 100644 index 00000000..dd662b19 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py @@ -0,0 +1,655 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.templated_pa_component_parameters_root import TemplatedPAComponentParametersRoot +from fds.analyticsapi.engines.model.templated_pa_component_post_summary_root import TemplatedPAComponentPostSummaryRoot +from fds.analyticsapi.engines.model.templated_pa_component_root import TemplatedPAComponentRoot +from fds.analyticsapi.engines.model.templated_pa_component_summary_root import TemplatedPAComponentSummaryRoot +from fds.analyticsapi.engines.model.templated_pa_component_update_parameters_root import TemplatedPAComponentUpdateParametersRoot + + +class TemplatedPAComponentsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __create_templated_pa_components( + self, + templated_pa_component_parameters_root, + **kwargs + ): + """Create templated PA component # noqa: E501 + + This endpoint creates new component based off of linked PA template or unlinked PA template. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_templated_pa_components(templated_pa_component_parameters_root, async_req=True) + >>> result = thread.get() + + Args: + templated_pa_component_parameters_root (TemplatedPAComponentParametersRoot): Request Parameters + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + TemplatedPAComponentPostSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['templated_pa_component_parameters_root'] = \ + templated_pa_component_parameters_root + return self.call_with_http_info(**kwargs) + + self.create_templated_pa_components = _Endpoint( + settings={ + 'response_type': dict({ 201:(TemplatedPAComponentPostSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/templated-components', + 'operation_id': 'create_templated_pa_components', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'templated_pa_component_parameters_root', + ], + 'required': [ + 'templated_pa_component_parameters_root', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'templated_pa_component_parameters_root': + (TemplatedPAComponentParametersRoot,), + }, + 'attribute_map': { + }, + 'location_map': { + 'templated_pa_component_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__create_templated_pa_components + ) + + def __delete_templated_pa_components( + self, + id, + **kwargs + ): + """Delete templated PA component # noqa: E501 + + This endpoint deletes an existing templated PA component # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_templated_pa_components(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for a templated PA component + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.delete_templated_pa_components = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/templated-components/{id}', + 'operation_id': 'delete_templated_pa_components', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__delete_templated_pa_components + ) + + def __get_templated_pa_component_by_id( + self, + id, + **kwargs + ): + """Get templated PA component by id # noqa: E501 + + This endpoint fetches the templated PA component settings. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_templated_pa_component_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for a templated PA component + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + TemplatedPAComponentRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_templated_pa_component_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(TemplatedPAComponentRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/templated-components/{id}', + 'operation_id': 'get_templated_pa_component_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_templated_pa_component_by_id + ) + + def __get_templated_pa_components_in_path( + self, + directory, + **kwargs + ): + """Get templated PA components in path # noqa: E501 + + This endpoint returns the list of templated PA components in path. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_templated_pa_components_in_path(directory, async_req=True) + >>> result = thread.get() + + Args: + directory (str): Get templated PA components in path + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + TemplatedPAComponentSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['directory'] = \ + directory + return self.call_with_http_info(**kwargs) + + self.get_templated_pa_components_in_path = _Endpoint( + settings={ + 'response_type': dict({ 200:(TemplatedPAComponentSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/templated-components', + 'operation_id': 'get_templated_pa_components_in_path', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'directory', + ], + 'required': [ + 'directory', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'directory': + (str,), + }, + 'attribute_map': { + 'directory': 'directory', + }, + 'location_map': { + 'directory': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_templated_pa_components_in_path + ) + + def __update_templated_pa_components( + self, + id, + templated_pa_component_update_parameters_root, + **kwargs + ): + """Update templated PA component # noqa: E501 + + This endpoint allows the user to change the request body from an existing templated PA component. Remarks: * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_templated_pa_components(id, templated_pa_component_update_parameters_root, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for a templated PA component + templated_pa_component_update_parameters_root (TemplatedPAComponentUpdateParametersRoot): Request Parameters + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + TemplatedPAComponentPostSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['templated_pa_component_update_parameters_root'] = \ + templated_pa_component_update_parameters_root + return self.call_with_http_info(**kwargs) + + self.update_templated_pa_components = _Endpoint( + settings={ + 'response_type': dict({ 200:(TemplatedPAComponentPostSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/templated-components/{id}', + 'operation_id': 'update_templated_pa_components', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'templated_pa_component_update_parameters_root', + ], + 'required': [ + 'id', + 'templated_pa_component_update_parameters_root', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'templated_pa_component_update_parameters_root': + (TemplatedPAComponentUpdateParametersRoot,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'templated_pa_component_update_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__update_templated_pa_components + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py new file mode 100644 index 00000000..4acbe929 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py @@ -0,0 +1,885 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details_root import UnlinkedPATemplateCategoryAndTypeDetailsRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_root import UnlinkedPATemplateCategoryAndTypeRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_parameters_root import UnlinkedPATemplateParametersRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary_root import UnlinkedPATemplatePostSummaryRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_root import UnlinkedPATemplateRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_summary_root import UnlinkedPATemplateSummaryRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters_root import UnlinkedPATemplateUpdateParametersRoot + + +class UnlinkedPATemplatesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __create_unlinked_pa_templates( + self, + unlinked_pa_template_parameters_root, + **kwargs + ): + """Create unlinked PA template # noqa: E501 + + This endpoint creates a template which is not linked to any specific PA3 tile. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_unlinked_pa_templates(unlinked_pa_template_parameters_root, async_req=True) + >>> result = thread.get() + + Args: + unlinked_pa_template_parameters_root (UnlinkedPATemplateParametersRoot): Request Parameters + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UnlinkedPATemplatePostSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['unlinked_pa_template_parameters_root'] = \ + unlinked_pa_template_parameters_root + return self.call_with_http_info(**kwargs) + + self.create_unlinked_pa_templates = _Endpoint( + settings={ + 'response_type': dict({ 201:(UnlinkedPATemplatePostSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates', + 'operation_id': 'create_unlinked_pa_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'unlinked_pa_template_parameters_root', + ], + 'required': [ + 'unlinked_pa_template_parameters_root', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'unlinked_pa_template_parameters_root': + (UnlinkedPATemplateParametersRoot,), + }, + 'attribute_map': { + }, + 'location_map': { + 'unlinked_pa_template_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__create_unlinked_pa_templates + ) + + def __delete_unlinked_pa_templates( + self, + id, + **kwargs + ): + """Delete unlinked PA template # noqa: E501 + + This endpoint deletes an existing unliked PA template. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_unlinked_pa_templates(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for an unlinked PA template + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.delete_unlinked_pa_templates = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/{id}', + 'operation_id': 'delete_unlinked_pa_templates', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__delete_unlinked_pa_templates + ) + + def __get_default_unlinked_pa_template_types( + self, + **kwargs + ): + """Get default unlinked PA template types. # noqa: E501 + + This endpoint fetches default unlinked PA template types. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_default_unlinked_pa_template_types(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UnlinkedPATemplateCategoryAndTypeRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_default_unlinked_pa_template_types = _Endpoint( + settings={ + 'response_type': dict({ 200:(UnlinkedPATemplateCategoryAndTypeRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/template-types', + 'operation_id': 'get_default_unlinked_pa_template_types', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_default_unlinked_pa_template_types + ) + + def __get_details_type( + self, + id, + **kwargs + ): + """Get unlinked PA template type details by id. # noqa: E501 + + This endpoint fetches the unlinked PA template type details. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_details_type(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for an unlinked PA template type + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UnlinkedPATemplateCategoryAndTypeDetailsRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_details_type = _Endpoint( + settings={ + 'response_type': dict({ 200:(UnlinkedPATemplateCategoryAndTypeDetailsRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/template-types/{id}', + 'operation_id': 'get_details_type', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_details_type + ) + + def __get_unlinked_pa_templates( + self, + **kwargs + ): + """Get unlinked PA templates # noqa: E501 + + This endpoint returns the list of unlinked PA templates. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_unlinked_pa_templates(async_req=True) + >>> result = thread.get() + + + Keyword Args: + directory (str): Get unlinked PA templates in path.. [optional] + category (str): Get unlinked PA templates by category.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UnlinkedPATemplateSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.get_unlinked_pa_templates = _Endpoint( + settings={ + 'response_type': dict({ 200:(UnlinkedPATemplateSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates', + 'operation_id': 'get_unlinked_pa_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'directory', + 'category', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'directory': + (str,), + 'category': + (str,), + }, + 'attribute_map': { + 'directory': 'directory', + 'category': 'category', + }, + 'location_map': { + 'directory': 'query', + 'category': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_unlinked_pa_templates + ) + + def __get_unlinked_pa_templates_by_id( + self, + id, + **kwargs + ): + """Get unlinked PA template details by id # noqa: E501 + + This endpoint fetches the template settings. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_unlinked_pa_templates_by_id(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for an unlinked PA template + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UnlinkedPATemplateRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.get_unlinked_pa_templates_by_id = _Endpoint( + settings={ + 'response_type': dict({ 200:(UnlinkedPATemplateRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/{id}', + 'operation_id': 'get_unlinked_pa_templates_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__get_unlinked_pa_templates_by_id + ) + + def __update_unlinked_pa_templates( + self, + id, + unlinked_pa_template_update_parameters_root, + **kwargs + ): + """Update unlinked PA template # noqa: E501 + + This endpoint updates an existing unlinked PA template. Remarks: * Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. If no mandatory fields are passed, then we can use the template as a component and skip the component creation. * Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\". * We cannot override the Locked fields when creating the Component. * Mandatory and locked strings are mutually exclusive. * Any settings in the POST body will act as a one-time override over the settings saved in the PA template. * Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Management System), VLT (Vaulted returns) or EXT (External Returns Data). Default holdings mode value is B&H. * Multi-horizon frequencies are not supported through this endpoint. * Componentdetail supports securities, groups, groupsall, and totals levels of granularity. However, if no value is passed, the default value is 'securities'. Additionally, while 'groupsall' returns all the group levels in the PA component, setting componentdetail to 'groups' only returns the expanded or collapsed group levels within the PA component. * If we are overriding the grouping with a frequency, we will be overriding the grouping saved to the original component and also overriding the default frequency of the Beginning of Period to whatever we pass in the request body. * If we are overriding grouping frequency without overriding the group id it will not be applied to the default groupings saved to the original component. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_unlinked_pa_templates(id, unlinked_pa_template_update_parameters_root, async_req=True) + >>> result = thread.get() + + Args: + id (str): Unique identifier for an unlinked PA template + unlinked_pa_template_update_parameters_root (UnlinkedPATemplateUpdateParametersRoot): Request Parameters + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is False. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UnlinkedPATemplatePostSummaryRoot + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', False + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['unlinked_pa_template_update_parameters_root'] = \ + unlinked_pa_template_update_parameters_root + return self.call_with_http_info(**kwargs) + + self.update_unlinked_pa_templates = _Endpoint( + settings={ + 'response_type': dict({ 200:(UnlinkedPATemplatePostSummaryRoot,), }), + 'auth': [ + 'Basic', + 'Bearer' + ], + 'endpoint_path': '/analytics/engines/pa/v3/unlinked-templates/{id}', + 'operation_id': 'update_unlinked_pa_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'unlinked_pa_template_update_parameters_root', + ], + 'required': [ + 'id', + 'unlinked_pa_template_update_parameters_root', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'unlinked_pa_template_update_parameters_root': + (UnlinkedPATemplateUpdateParametersRoot,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'unlinked_pa_template_update_parameters_root': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client, + callable=__update_unlinked_pa_templates + ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py index a8badc47..40498039 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py @@ -19,6 +19,8 @@ from fds.analyticsapi.engines.api.accounts_api import AccountsApi from fds.analyticsapi.engines.api.bpm_optimizer_api import BPMOptimizerApi from fds.analyticsapi.engines.api.benchmarks_api import BenchmarksApi +from fds.analyticsapi.engines.api.column_statistics_api import ColumnStatisticsApi +from fds.analyticsapi.engines.api.columns_api import ColumnsApi from fds.analyticsapi.engines.api.components_api import ComponentsApi from fds.analyticsapi.engines.api.configurations_api import ConfigurationsApi from fds.analyticsapi.engines.api.currencies_api import CurrenciesApi @@ -27,11 +29,18 @@ from fds.analyticsapi.engines.api.documents_api import DocumentsApi from fds.analyticsapi.engines.api.fiab_calculations_api import FIABCalculationsApi from fds.analyticsapi.engines.api.fi_calculations_api import FICalculationsApi +from fds.analyticsapi.engines.api.fpo_optimizer_api import FPOOptimizerApi from fds.analyticsapi.engines.api.frequencies_api import FrequenciesApi +from fds.analyticsapi.engines.api.groups_api import GroupsApi +from fds.analyticsapi.engines.api.linked_pa_templates_api import LinkedPATemplatesApi from fds.analyticsapi.engines.api.npo_optimizer_api import NPOOptimizerApi +from fds.analyticsapi.engines.api.pa_calculations_api import PACalculationsApi +from fds.analyticsapi.engines.api.pricing_sources_api import PricingSourcesApi from fds.analyticsapi.engines.api.pub_calculations_api import PubCalculationsApi from fds.analyticsapi.engines.api.quant_calculations_api import QuantCalculationsApi from fds.analyticsapi.engines.api.spar_calculations_api import SPARCalculationsApi from fds.analyticsapi.engines.api.strategy_documents_api import StrategyDocumentsApi +from fds.analyticsapi.engines.api.templated_pa_components_api import TemplatedPAComponentsApi +from fds.analyticsapi.engines.api.unlinked_pa_templates_api import UnlinkedPATemplatesApi from fds.analyticsapi.engines.api.vault_calculations_api import VaultCalculationsApi from fds.analyticsapi.engines.api.vault_attribution_loader_api import VaultAttributionLoaderApi diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column.py new file mode 100644 index 00000000..473e4343 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/column.py @@ -0,0 +1,176 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class Column(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'defaultstatisticsids': ([str],), # noqa: E501 + 'name': (str,), # noqa: E501 + 'directory': (str,), # noqa: E501 + 'category': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'defaultstatisticsids': 'defaultstatisticsids', # noqa: E501 + 'name': 'name', # noqa: E501 + 'directory': 'directory', # noqa: E501 + 'category': 'category', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Column - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + defaultstatisticsids ([str]): Column statistic Id. [optional] # noqa: E501 + name (str): Column Name. [optional] # noqa: E501 + directory (str): Column Directory. [optional] # noqa: E501 + category (str): Column Category. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_root.py new file mode 100644 index 00000000..b427916a --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/column_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.column import Column + globals()['Column'] = Column + + +class ColumnRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (Column,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """ColumnRoot - a model defined in OpenAPI + + Args: + data (Column): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic.py new file mode 100644 index 00000000..81f93b18 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic.py @@ -0,0 +1,167 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class ColumnStatistic(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ColumnStatistic - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Column Statistic Name. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic_root.py new file mode 100644 index 00000000..95bf7b33 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/column_statistic_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.column_statistic import ColumnStatistic + globals()['ColumnStatistic'] = ColumnStatistic + + +class ColumnStatisticRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (ColumnStatistic,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """ColumnStatisticRoot - a model defined in OpenAPI + + Args: + data ({str: (ColumnStatistic,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary.py new file mode 100644 index 00000000..bdba6fd7 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class ColumnSummary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'directory': (str,), # noqa: E501 + 'category': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'directory': 'directory', # noqa: E501 + 'category': 'category', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ColumnSummary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Column Name. [optional] # noqa: E501 + directory (str): Column Directory. [optional] # noqa: E501 + category (str): Column Category. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary_root.py new file mode 100644 index 00000000..3a1a7998 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/column_summary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.column_summary import ColumnSummary + globals()['ColumnSummary'] = ColumnSummary + + +class ColumnSummaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (ColumnSummary,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """ColumnSummaryRoot - a model defined in OpenAPI + + Args: + data ({str: (ColumnSummary,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_account.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_account.py new file mode 100644 index 00000000..64ff897d --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_account.py @@ -0,0 +1,183 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.optimizer_account_overrides import OptimizerAccountOverrides + from fds.analyticsapi.engines.model.pa_doc import PaDoc + globals()['OptimizerAccountOverrides'] = OptimizerAccountOverrides + globals()['PaDoc'] = PaDoc + + +class FPOAccount(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'pa_document': (PaDoc,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'overrides': (OptimizerAccountOverrides,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'pa_document': 'paDocument', # noqa: E501 + 'id': 'id', # noqa: E501 + 'overrides': 'overrides', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, pa_document, *args, **kwargs): # noqa: E501 + """FPOAccount - a model defined in OpenAPI + + Args: + pa_document (PaDoc): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Account path. [optional] # noqa: E501 + overrides (OptimizerAccountOverrides): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.pa_document = pa_document + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_objective.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_objective.py new file mode 100644 index 00000000..30063224 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_objective.py @@ -0,0 +1,174 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class FPOObjective(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('terms',): { + 'DISABLE': "Disable", + 'ENABLE': "Enable", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'active': (str,), # noqa: E501 + 'terms': ({str: (str,)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'active': 'active', # noqa: E501 + 'terms': 'terms', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FPOObjective - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + active (str): [optional] # noqa: E501 + terms ({str: (str,)}): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters.py new file mode 100644 index 00000000..110fd894 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters.py @@ -0,0 +1,191 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.fpo_account import FPOAccount + from fds.analyticsapi.engines.model.fpo_optimizer_strategy import FPOOptimizerStrategy + from fds.analyticsapi.engines.model.optimization import Optimization + from fds.analyticsapi.engines.model.optimizer_output_types import OptimizerOutputTypes + globals()['FPOAccount'] = FPOAccount + globals()['FPOOptimizerStrategy'] = FPOOptimizerStrategy + globals()['Optimization'] = Optimization + globals()['OptimizerOutputTypes'] = OptimizerOutputTypes + + +class FPOOptimizationParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'strategy': (FPOOptimizerStrategy,), # noqa: E501 + 'output_types': (OptimizerOutputTypes,), # noqa: E501 + 'account': (FPOAccount,), # noqa: E501 + 'optimization': (Optimization,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'strategy': 'strategy', # noqa: E501 + 'output_types': 'outputTypes', # noqa: E501 + 'account': 'account', # noqa: E501 + 'optimization': 'optimization', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, strategy, output_types, *args, **kwargs): # noqa: E501 + """FPOOptimizationParameters - a model defined in OpenAPI + + Args: + strategy (FPOOptimizerStrategy): + output_types (OptimizerOutputTypes): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + account (FPOAccount): [optional] # noqa: E501 + optimization (Optimization): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.strategy = strategy + self.output_types = output_types + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py new file mode 100644 index 00000000..2bbe8205 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimization_parameters_root.py @@ -0,0 +1,175 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.fpo_optimization_parameters import FPOOptimizationParameters + globals()['FPOOptimizationParameters'] = FPOOptimizationParameters + + +class FPOOptimizationParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (FPOOptimizationParameters,), # noqa: E501 + 'meta': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FPOOptimizationParametersRoot - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (FPOOptimizationParameters): [optional] # noqa: E501 + meta ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy.py new file mode 100644 index 00000000..8990305b --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.fpo_optimizer_strategy_overrides import FPOOptimizerStrategyOverrides + globals()['FPOOptimizerStrategyOverrides'] = FPOOptimizerStrategyOverrides + + +class FPOOptimizerStrategy(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'overrides': (FPOOptimizerStrategyOverrides,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'overrides': 'overrides', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """FPOOptimizerStrategy - a model defined in OpenAPI + + Args: + id (str): OptimizerStrategy document path + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + overrides (FPOOptimizerStrategyOverrides): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py new file mode 100644 index 00000000..190ce922 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fpo_optimizer_strategy_overrides.py @@ -0,0 +1,185 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.fpo_objective import FPOObjective + globals()['FPOObjective'] = FPOObjective + + +class FPOOptimizerStrategyOverrides(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('constraints',): { + 'DISABLE': "Disable", + 'ENABLE': "Enable", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'objective': (FPOObjective,), # noqa: E501 + 'constraints': ({str: (str,)},), # noqa: E501 + 'alpha': (str,), # noqa: E501 + 'transaction_cost': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'objective': 'objective', # noqa: E501 + 'constraints': 'constraints', # noqa: E501 + 'alpha': 'alpha', # noqa: E501 + 'transaction_cost': 'transactionCost', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FPOOptimizerStrategyOverrides - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + objective (FPOObjective): [optional] # noqa: E501 + constraints ({str: (str,)}): List of constraints. [optional] # noqa: E501 + alpha (str): Alpha. [optional] # noqa: E501 + transaction_cost (str): Transaction cost. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/group.py b/auto-generated-sdk/fds/analyticsapi/engines/model/group.py new file mode 100644 index 00000000..34f0edbf --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/group.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class Group(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'directory': (str,), # noqa: E501 + 'category': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'directory': 'directory', # noqa: E501 + 'category': 'category', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Group - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Group Name. [optional] # noqa: E501 + directory (str): Group Directory. [optional] # noqa: E501 + category (str): Group Category. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/group_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/group_root.py new file mode 100644 index 00000000..b28550d1 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/group_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.group import Group + globals()['Group'] = Group + + +class GroupRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (Group,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """GroupRoot - a model defined in OpenAPI + + Args: + data ({str: (Group,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template.py new file mode 100644 index 00000000..5ff02893 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template.py @@ -0,0 +1,190 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes + globals()['TemplateContentTypes'] = TemplateContentTypes + + +class LinkedPATemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'directory': (str,), # noqa: E501 + 'snapshot': (bool,), # noqa: E501 + 'content': (TemplateContentTypes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'parent_component_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'directory': 'directory', # noqa: E501 + 'snapshot': 'snapshot', # noqa: E501 + 'content': 'content', # noqa: E501 + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'parent_component_id': 'parentComponentId', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedPATemplate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + directory (str): Template directory.. [optional] # noqa: E501 + snapshot (bool): snapshot.. [optional] # noqa: E501 + content (TemplateContentTypes): [optional] # noqa: E501 + id (str): Template id.. [optional] # noqa: E501 + description (str): Template description.. [optional] # noqa: E501 + name (str): Template name.. [optional] # noqa: E501 + parent_component_id (str): Template parent tile.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters.py new file mode 100644 index 00000000..6a269ab8 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters.py @@ -0,0 +1,185 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes + globals()['TemplateContentTypes'] = TemplateContentTypes + + +class LinkedPATemplateParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'directory': (str,), # noqa: E501 + 'parent_component_id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'content': (TemplateContentTypes,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'directory': 'directory', # noqa: E501 + 'parent_component_id': 'parentComponentId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'content': 'content', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, directory, parent_component_id, *args, **kwargs): # noqa: E501 + """LinkedPATemplateParameters - a model defined in OpenAPI + + Args: + directory (str): The directory to create a linked PA template + parent_component_id (str): Parent component id + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Template description. [optional] # noqa: E501 + content (TemplateContentTypes): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.directory = directory + self.parent_component_id = parent_component_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py new file mode 100644 index 00000000..d364390e --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_parameters_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.linked_pa_template_parameters import LinkedPATemplateParameters + globals()['LinkedPATemplateParameters'] = LinkedPATemplateParameters + + +class LinkedPATemplateParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (LinkedPATemplateParameters,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """LinkedPATemplateParametersRoot - a model defined in OpenAPI + + Args: + data (LinkedPATemplateParameters): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary.py new file mode 100644 index 00000000..d80494aa --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary.py @@ -0,0 +1,176 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class LinkedPATemplatePostSummary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'parent_component_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'parent_component_id': 'parentComponentId', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedPATemplatePostSummary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Template id.. [optional] # noqa: E501 + description (str): Template description.. [optional] # noqa: E501 + name (str): Template name.. [optional] # noqa: E501 + parent_component_id (str): Template parent tile.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py new file mode 100644 index 00000000..a5adb81c --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_post_summary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.linked_pa_template_post_summary import LinkedPATemplatePostSummary + globals()['LinkedPATemplatePostSummary'] = LinkedPATemplatePostSummary + + +class LinkedPATemplatePostSummaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (LinkedPATemplatePostSummary,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """LinkedPATemplatePostSummaryRoot - a model defined in OpenAPI + + Args: + data (LinkedPATemplatePostSummary): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_root.py new file mode 100644 index 00000000..cb01d4f6 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.linked_pa_template import LinkedPATemplate + globals()['LinkedPATemplate'] = LinkedPATemplate + + +class LinkedPATemplateRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (LinkedPATemplate,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """LinkedPATemplateRoot - a model defined in OpenAPI + + Args: + data (LinkedPATemplate): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary.py new file mode 100644 index 00000000..4ecced42 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class LinkedPATemplateSummary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'parent_component_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'parent_component_id': 'parentComponentId', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedPATemplateSummary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Template description.. [optional] # noqa: E501 + name (str): Template name.. [optional] # noqa: E501 + parent_component_id (str): Template parent tile.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary_root.py new file mode 100644 index 00000000..e781b212 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_summary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.linked_pa_template_summary import LinkedPATemplateSummary + globals()['LinkedPATemplateSummary'] = LinkedPATemplateSummary + + +class LinkedPATemplateSummaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (LinkedPATemplateSummary,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """LinkedPATemplateSummaryRoot - a model defined in OpenAPI + + Args: + data ({str: (LinkedPATemplateSummary,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py new file mode 100644 index 00000000..7417226d --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes + globals()['TemplateContentTypes'] = TemplateContentTypes + + +class LinkedPATemplateUpdateParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'parent_component_id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'content': (TemplateContentTypes,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'parent_component_id': 'parentComponentId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'content': 'content', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedPATemplateUpdateParameters - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + parent_component_id (str): Parent component id. [optional] # noqa: E501 + description (str): Template description. [optional] # noqa: E501 + content (TemplateContentTypes): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py new file mode 100644 index 00000000..f71b046a --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.linked_pa_template_update_parameters import LinkedPATemplateUpdateParameters + globals()['LinkedPATemplateUpdateParameters'] = LinkedPATemplateUpdateParameters + + +class LinkedPATemplateUpdateParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (LinkedPATemplateUpdateParameters,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """LinkedPATemplateUpdateParametersRoot - a model defined in OpenAPI + + Args: + data (LinkedPATemplateUpdateParameters): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/metadata.py b/auto-generated-sdk/fds/analyticsapi/engines/model/metadata.py new file mode 100644 index 00000000..70fdc030 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/metadata.py @@ -0,0 +1,187 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_commentary_date import PACommentaryDate + globals()['PACommentaryDate'] = PACommentaryDate + + +class Metadata(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'tile_name': (str,), # noqa: E501 + 'portfolio_description': (str,), # noqa: E501 + 'benchmark_description': (str,), # noqa: E501 + 'start_date': (PACommentaryDate,), # noqa: E501 + 'end_date': (PACommentaryDate,), # noqa: E501 + 'frequency': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'tile_name': 'tileName', # noqa: E501 + 'portfolio_description': 'portfolioDescription', # noqa: E501 + 'benchmark_description': 'benchmarkDescription', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'frequency': 'frequency', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Metadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + tile_name (str): PA Tile name associated with the component. [optional] # noqa: E501 + portfolio_description (str): Portfolio name used in generating commentary. [optional] # noqa: E501 + benchmark_description (str): Benchmark name used in generating commentary. [optional] # noqa: E501 + start_date (PACommentaryDate): [optional] # noqa: E501 + end_date (PACommentaryDate): [optional] # noqa: E501 + frequency (str): Date frequency. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_column.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_column.py new file mode 100644 index 00000000..3ca30ae9 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_column.py @@ -0,0 +1,170 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PACalculationColumn(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'statistics': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'statistics': 'statistics', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACalculationColumn - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): FactSet-defined or User-defined Column identifier.. [optional] # noqa: E501 + statistics ([str]): Column Statistic identifier. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_data_sources.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_data_sources.py new file mode 100644 index 00000000..86a74fc8 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_data_sources.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_calculation_pricing_source import PACalculationPricingSource + globals()['PACalculationPricingSource'] = PACalculationPricingSource + + +class PACalculationDataSources(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'portfoliopricingsources': ([PACalculationPricingSource],), # noqa: E501 + 'benchmarkpricingsources': ([PACalculationPricingSource],), # noqa: E501 + 'useportfoliopricingsourcesforbenchmark': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'portfoliopricingsources': 'portfoliopricingsources', # noqa: E501 + 'benchmarkpricingsources': 'benchmarkpricingsources', # noqa: E501 + 'useportfoliopricingsourcesforbenchmark': 'useportfoliopricingsourcesforbenchmark', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACalculationDataSources - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + portfoliopricingsources ([PACalculationPricingSource]): List of portfilio pricing source for the PA calculation. [optional] # noqa: E501 + benchmarkpricingsources ([PACalculationPricingSource]): List of benchmark pricing source for the PA calculation. [optional] # noqa: E501 + useportfoliopricingsourcesforbenchmark (bool): Use portfolio pricing sources for benchmark. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_group.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_group.py new file mode 100644 index 00000000..68e30cf0 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_group.py @@ -0,0 +1,170 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PACalculationGroup(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'frequency': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'frequency': 'frequency', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACalculationGroup - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): FactSet-defined or User-defined Group identifier.. [optional] # noqa: E501 + frequency (str): Grouping frequency. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters.py new file mode 100644 index 00000000..0dac14be --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters.py @@ -0,0 +1,207 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn + from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources + from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup + from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters + from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier + globals()['PACalculationColumn'] = PACalculationColumn + globals()['PACalculationDataSources'] = PACalculationDataSources + globals()['PACalculationGroup'] = PACalculationGroup + globals()['PADateParameters'] = PADateParameters + globals()['PAIdentifier'] = PAIdentifier + + +class PACalculationParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'componentid': (str,), # noqa: E501 + 'accounts': ([PAIdentifier],), # noqa: E501 + 'benchmarks': ([PAIdentifier],), # noqa: E501 + 'dates': (PADateParameters,), # noqa: E501 + 'groups': ([PACalculationGroup],), # noqa: E501 + 'currencyisocode': (str,), # noqa: E501 + 'columns': ([PACalculationColumn],), # noqa: E501 + 'datasources': (PACalculationDataSources,), # noqa: E501 + 'componentdetail': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'componentid': 'componentid', # noqa: E501 + 'accounts': 'accounts', # noqa: E501 + 'benchmarks': 'benchmarks', # noqa: E501 + 'dates': 'dates', # noqa: E501 + 'groups': 'groups', # noqa: E501 + 'currencyisocode': 'currencyisocode', # noqa: E501 + 'columns': 'columns', # noqa: E501 + 'datasources': 'datasources', # noqa: E501 + 'componentdetail': 'componentdetail', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, componentid, *args, **kwargs): # noqa: E501 + """PACalculationParameters - a model defined in OpenAPI + + Args: + componentid (str): The PA Engine component identifier to analyze. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + accounts ([PAIdentifier]): List of accounts.. [optional] # noqa: E501 + benchmarks ([PAIdentifier]): List of benchmarks.. [optional] # noqa: E501 + dates (PADateParameters): [optional] # noqa: E501 + groups ([PACalculationGroup]): List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.. [optional] # noqa: E501 + currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 + columns ([PACalculationColumn]): List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.. [optional] # noqa: E501 + datasources (PACalculationDataSources): [optional] # noqa: E501 + componentdetail (str): Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.componentid = componentid + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters_root.py new file mode 100644 index 00000000..b8000417 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_parameters_root.py @@ -0,0 +1,177 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.calculation_meta import CalculationMeta + from fds.analyticsapi.engines.model.pa_calculation_parameters import PACalculationParameters + globals()['CalculationMeta'] = CalculationMeta + globals()['PACalculationParameters'] = PACalculationParameters + + +class PACalculationParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (PACalculationParameters,)},), # noqa: E501 + 'meta': (CalculationMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACalculationParametersRoot - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ({str: (PACalculationParameters,)}): List of calculation parameters.. [optional] # noqa: E501 + meta (CalculationMeta): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_pricing_source.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_pricing_source.py new file mode 100644 index 00000000..c24c6ebe --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_calculation_pricing_source.py @@ -0,0 +1,167 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PACalculationPricingSource(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACalculationPricingSource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Pricing source identifier. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary.py new file mode 100644 index 00000000..38d79e02 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.section import Section + globals()['Section'] = Section + + +class PACommentary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'commentary_id': (str,), # noqa: E501 + 'sections': ([Section],), # noqa: E501 + 'disclaimer': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'commentary_id': 'commentaryId', # noqa: E501 + 'sections': 'sections', # noqa: E501 + 'disclaimer': 'disclaimer', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACommentary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + commentary_id (str): Generated commentary Id. [optional] # noqa: E501 + sections ([Section]): Commentary sections. [optional] # noqa: E501 + disclaimer (str): Disclaimer. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py new file mode 100644 index 00000000..335b2794 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py @@ -0,0 +1,170 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PACommentaryConfigurationSummary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'directory': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'directory': 'directory', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACommentaryConfigurationSummary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): PA commentary configuration name. [optional] # noqa: E501 + directory (str): PA Commentary configuration directory. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py new file mode 100644 index 00000000..720de8ac --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_commentary_configuration_summary import PACommentaryConfigurationSummary + globals()['PACommentaryConfigurationSummary'] = PACommentaryConfigurationSummary + + +class PACommentaryConfigurationSummaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (PACommentaryConfigurationSummary,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """PACommentaryConfigurationSummaryRoot - a model defined in OpenAPI + + Args: + data ({str: (PACommentaryConfigurationSummary,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_date.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_date.py new file mode 100644 index 00000000..afc1eeff --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_date.py @@ -0,0 +1,170 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PACommentaryDate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'yyyymmdd': (int,), # noqa: E501 + 'relative': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'yyyymmdd': 'yyyymmdd', # noqa: E501 + 'relative': 'relative', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACommentaryDate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + yyyymmdd (int): Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time.. [optional] # noqa: E501 + relative (str): Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status.py new file mode 100644 index 00000000..f2045afc --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status.py @@ -0,0 +1,177 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PACommentaryGetStatus(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'EXECUTING': "Executing", + 'SUCCESS': "Success", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'calculationid': (str,), # noqa: E501 + 'unitid': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'calculationid': 'calculationid', # noqa: E501 + 'unitid': 'unitid', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACommentaryGetStatus - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + calculationid (str): Calculation id.. [optional] # noqa: E501 + unitid (str): Calculation unit id.. [optional] # noqa: E501 + status (str): The status of commentary generation.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status_root.py new file mode 100644 index 00000000..b60b6d03 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_commentary_get_status import PACommentaryGetStatus + globals()['PACommentaryGetStatus'] = PACommentaryGetStatus + + +class PACommentaryGetStatusRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (PACommentaryGetStatus,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """PACommentaryGetStatusRoot - a model defined in OpenAPI + + Args: + data (PACommentaryGetStatus): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters.py new file mode 100644 index 00000000..04a10ff2 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters.py @@ -0,0 +1,167 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PACommentaryParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'configurationid': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'configurationid': 'configurationid', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACommentaryParameters - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + configurationid (str): Commentary configuration id. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters_root.py new file mode 100644 index 00000000..41317920 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_commentary_parameters import PACommentaryParameters + globals()['PACommentaryParameters'] = PACommentaryParameters + + +class PACommentaryParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (PACommentaryParameters,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """PACommentaryParametersRoot - a model defined in OpenAPI + + Args: + data (PACommentaryParameters): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_root.py new file mode 100644 index 00000000..4cbb2fe7 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_commentary import PACommentary + globals()['PACommentary'] = PACommentary + + +class PACommentaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (PACommentary,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """PACommentaryRoot - a model defined in OpenAPI + + Args: + data (PACommentary): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status.py new file mode 100644 index 00000000..52358e2a --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status.py @@ -0,0 +1,180 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PACommentaryStatus(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'EXECUTING': "Executing", + 'SUCCESS': "Success", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'result': (str,), # noqa: E501 + 'calculationid': (str,), # noqa: E501 + 'unitid': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'result': 'result', # noqa: E501 + 'calculationid': 'calculationid', # noqa: E501 + 'unitid': 'unitid', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PACommentaryStatus - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + result (str): The result url of the generated commentary.. [optional] # noqa: E501 + calculationid (str): Calculation id.. [optional] # noqa: E501 + unitid (str): Calculation unit id.. [optional] # noqa: E501 + status (str): The status of commentary generation.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status_root.py new file mode 100644 index 00000000..4b9cece9 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_commentary_status import PACommentaryStatus + globals()['PACommentaryStatus'] = PACommentaryStatus + + +class PACommentaryStatusRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (PACommentaryStatus,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """PACommentaryStatusRoot - a model defined in OpenAPI + + Args: + data (PACommentaryStatus): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component.py new file mode 100644 index 00000000..cc3bb3f3 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component.py @@ -0,0 +1,198 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters + from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier + globals()['PADateParameters'] = PADateParameters + globals()['PAIdentifier'] = PAIdentifier + + +class PAComponent(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'accounts': ([PAIdentifier],), # noqa: E501 + 'benchmarks': ([PAIdentifier],), # noqa: E501 + 'currencyisocode': (str,), # noqa: E501 + 'dates': (PADateParameters,), # noqa: E501 + 'snapshot': (bool,), # noqa: E501 + 'path': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'category': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'accounts': 'accounts', # noqa: E501 + 'benchmarks': 'benchmarks', # noqa: E501 + 'currencyisocode': 'currencyisocode', # noqa: E501 + 'dates': 'dates', # noqa: E501 + 'snapshot': 'snapshot', # noqa: E501 + 'path': 'path', # noqa: E501 + 'name': 'name', # noqa: E501 + 'category': 'category', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PAComponent - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Component identifier.. [optional] # noqa: E501 + accounts ([PAIdentifier]): List of accounts saved in the PA document.. [optional] # noqa: E501 + benchmarks ([PAIdentifier]): List of benchmarks saved in the PA document.. [optional] # noqa: E501 + currencyisocode (str): [optional] # noqa: E501 + dates (PADateParameters): [optional] # noqa: E501 + snapshot (bool): Is the component type snapshot or subperiod.. [optional] # noqa: E501 + path (str): The path to the document. [optional] # noqa: E501 + name (str): Component name.. [optional] # noqa: E501 + category (str): Component category.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_data.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_data.py new file mode 100644 index 00000000..da54419e --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_data.py @@ -0,0 +1,201 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn + from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources + from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup + from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters + from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier + globals()['PACalculationColumn'] = PACalculationColumn + globals()['PACalculationDataSources'] = PACalculationDataSources + globals()['PACalculationGroup'] = PACalculationGroup + globals()['PADateParameters'] = PADateParameters + globals()['PAIdentifier'] = PAIdentifier + + +class PAComponentData(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'accounts': ([PAIdentifier],), # noqa: E501 + 'benchmarks': ([PAIdentifier],), # noqa: E501 + 'groups': ([PACalculationGroup],), # noqa: E501 + 'columns': ([PACalculationColumn],), # noqa: E501 + 'dates': (PADateParameters,), # noqa: E501 + 'datasources': (PACalculationDataSources,), # noqa: E501 + 'currencyisocode': (str,), # noqa: E501 + 'componentdetail': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'accounts': 'accounts', # noqa: E501 + 'benchmarks': 'benchmarks', # noqa: E501 + 'groups': 'groups', # noqa: E501 + 'columns': 'columns', # noqa: E501 + 'dates': 'dates', # noqa: E501 + 'datasources': 'datasources', # noqa: E501 + 'currencyisocode': 'currencyisocode', # noqa: E501 + 'componentdetail': 'componentdetail', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PAComponentData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + accounts ([PAIdentifier]): List of accounts.. [optional] # noqa: E501 + benchmarks ([PAIdentifier]): List of benchmarks.. [optional] # noqa: E501 + groups ([PACalculationGroup]): List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document.. [optional] # noqa: E501 + columns ([PACalculationColumn]): List of columns for the PA calculation. This will take precedence over the columns saved in the PA document.. [optional] # noqa: E501 + dates (PADateParameters): [optional] # noqa: E501 + datasources (PACalculationDataSources): [optional] # noqa: E501 + currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 + componentdetail (str): PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_root.py new file mode 100644 index 00000000..f4313a19 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_component_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_component import PAComponent + globals()['PAComponent'] = PAComponent + + +class PAComponentRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (PAComponent,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """PAComponentRoot - a model defined in OpenAPI + + Args: + data (PAComponent): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_date_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_date_parameters.py new file mode 100644 index 00000000..d66758ef --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_date_parameters.py @@ -0,0 +1,177 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PADateParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'enddate': (str,), # noqa: E501 + 'frequency': (str,), # noqa: E501 + 'startdate': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'enddate': 'enddate', # noqa: E501 + 'frequency': 'frequency', # noqa: E501 + 'startdate': 'startdate', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, enddate, frequency, *args, **kwargs): # noqa: E501 + """PADateParameters - a model defined in OpenAPI + + Args: + enddate (str): Calculation's end date. + frequency (str): Calculation's frequency. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + startdate (str): Calculation's start date.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.enddate = enddate + self.frequency = frequency + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_doc.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_doc.py new file mode 100644 index 00000000..f7f1e6ab --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_doc.py @@ -0,0 +1,170 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PaDoc(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """PaDoc - a model defined in OpenAPI + + Args: + id (str): PA document path + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_identifier.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_identifier.py new file mode 100644 index 00000000..8345d42e --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_identifier.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PAIdentifier(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'holdingsmode': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'holdingsmode': 'holdingsmode', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """PAIdentifier - a model defined in OpenAPI + + Args: + id (str): User's FactSet account path OR benchmark. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + holdingsmode (str): Holdings Mode can be B&H, TBR, OMS , EXT or VLT.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source.py new file mode 100644 index 00000000..18c85553 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class PAPricingSource(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'directory': (str,), # noqa: E501 + 'category': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'directory': 'directory', # noqa: E501 + 'category': 'category', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PAPricingSource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Pricing source Name. [optional] # noqa: E501 + directory (str): Pricing source directory. [optional] # noqa: E501 + category (str): Pricing source category. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source_root.py new file mode 100644 index 00000000..f2a03b10 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_pricing_source_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_pricing_source import PAPricingSource + globals()['PAPricingSource'] = PAPricingSource + + +class PAPricingSourceRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (PAPricingSource,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """PAPricingSourceRoot - a model defined in OpenAPI + + Args: + data ({str: (PAPricingSource,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/section.py b/auto-generated-sdk/fds/analyticsapi/engines/model/section.py new file mode 100644 index 00000000..9c60b1ff --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/section.py @@ -0,0 +1,181 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.metadata import Metadata + globals()['Metadata'] = Metadata + + +class Section(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'metadata': (Metadata,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'content': (str,), # noqa: E501 + 'sub_sections': ([Section],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'metadata': 'metadata', # noqa: E501 + 'title': 'title', # noqa: E501 + 'content': 'content', # noqa: E501 + 'sub_sections': 'subSections', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Section - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + metadata (Metadata): [optional] # noqa: E501 + title (str): Commentary title. [optional] # noqa: E501 + content (str): Generated commentary content. [optional] # noqa: E501 + sub_sections ([Section]): Generated commentary subsections. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/template_content_types.py b/auto-generated-sdk/fds/analyticsapi/engines/model/template_content_types.py new file mode 100644 index 00000000..d1d271f9 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/template_content_types.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class TemplateContentTypes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'mandatory': ([str],), # noqa: E501 + 'optional': ([str],), # noqa: E501 + 'locked': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'mandatory': 'mandatory', # noqa: E501 + 'optional': 'optional', # noqa: E501 + 'locked': 'locked', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TemplateContentTypes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + mandatory ([str]): Template mandatory fields. [optional] # noqa: E501 + optional ([str]): Template optional fields. [optional] # noqa: E501 + locked ([str]): Template locked fields. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component.py new file mode 100644 index 00000000..c27be4e4 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component.py @@ -0,0 +1,193 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_component_data import PAComponentData + globals()['PAComponentData'] = PAComponentData + + +class TemplatedPAComponent(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'directory': (str,), # noqa: E501 + 'snapshot': (bool,), # noqa: E501 + 'component_data': (PAComponentData,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'parent_template_id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'directory': 'directory', # noqa: E501 + 'snapshot': 'snapshot', # noqa: E501 + 'component_data': 'componentData', # noqa: E501 + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'parent_template_id': 'parentTemplateId', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TemplatedPAComponent - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + directory (str): [optional] # noqa: E501 + snapshot (bool): [optional] # noqa: E501 + component_data (PAComponentData): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + parent_template_id (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters.py new file mode 100644 index 00000000..bce9a33a --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters.py @@ -0,0 +1,185 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_component_data import PAComponentData + globals()['PAComponentData'] = PAComponentData + + +class TemplatedPAComponentParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'directory': (str,), # noqa: E501 + 'parent_template_id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'component_data': (PAComponentData,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'directory': 'directory', # noqa: E501 + 'parent_template_id': 'parentTemplateId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'component_data': 'componentData', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, directory, parent_template_id, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentParameters - a model defined in OpenAPI + + Args: + directory (str): Directory to create templated components + parent_template_id (str): Parent template id + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Component description.. [optional] # noqa: E501 + component_data (PAComponentData): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.directory = directory + self.parent_template_id = parent_template_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py new file mode 100644 index 00000000..a0cc6efd --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_parameters_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.templated_pa_component_parameters import TemplatedPAComponentParameters + globals()['TemplatedPAComponentParameters'] = TemplatedPAComponentParameters + + +class TemplatedPAComponentParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (TemplatedPAComponentParameters,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentParametersRoot - a model defined in OpenAPI + + Args: + data (TemplatedPAComponentParameters): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary.py new file mode 100644 index 00000000..f7a0a345 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary.py @@ -0,0 +1,179 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class TemplatedPAComponentPostSummary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'parent_template_id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'parent_template_id': 'parentTemplateId', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentPostSummary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + parent_template_id (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py new file mode 100644 index 00000000..47f46386 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_post_summary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.templated_pa_component_post_summary import TemplatedPAComponentPostSummary + globals()['TemplatedPAComponentPostSummary'] = TemplatedPAComponentPostSummary + + +class TemplatedPAComponentPostSummaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (TemplatedPAComponentPostSummary,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentPostSummaryRoot - a model defined in OpenAPI + + Args: + data (TemplatedPAComponentPostSummary): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_root.py new file mode 100644 index 00000000..6121b0e8 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.templated_pa_component import TemplatedPAComponent + globals()['TemplatedPAComponent'] = TemplatedPAComponent + + +class TemplatedPAComponentRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (TemplatedPAComponent,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentRoot - a model defined in OpenAPI + + Args: + data (TemplatedPAComponent): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary.py new file mode 100644 index 00000000..1c2c84cc --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary.py @@ -0,0 +1,176 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class TemplatedPAComponentSummary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'parent_template_id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'parent_template_id': 'parentTemplateId', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentSummary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + parent_template_id (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary_root.py new file mode 100644 index 00000000..ec00aa3a --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_summary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.templated_pa_component_summary import TemplatedPAComponentSummary + globals()['TemplatedPAComponentSummary'] = TemplatedPAComponentSummary + + +class TemplatedPAComponentSummaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (TemplatedPAComponentSummary,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentSummaryRoot - a model defined in OpenAPI + + Args: + data ({str: (TemplatedPAComponentSummary,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py new file mode 100644 index 00000000..2276100b --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_component_data import PAComponentData + globals()['PAComponentData'] = PAComponentData + + +class TemplatedPAComponentUpdateParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'parent_template_id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'component_data': (PAComponentData,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'parent_template_id': 'parentTemplateId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'component_data': 'componentData', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentUpdateParameters - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + parent_template_id (str): Parent template id. [optional] # noqa: E501 + description (str): Component description.. [optional] # noqa: E501 + component_data (PAComponentData): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py new file mode 100644 index 00000000..477e0bd3 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/templated_pa_component_update_parameters_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.templated_pa_component_update_parameters import TemplatedPAComponentUpdateParameters + globals()['TemplatedPAComponentUpdateParameters'] = TemplatedPAComponentUpdateParameters + + +class TemplatedPAComponentUpdateParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (TemplatedPAComponentUpdateParameters,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """TemplatedPAComponentUpdateParametersRoot - a model defined in OpenAPI + + Args: + data (TemplatedPAComponentUpdateParameters): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template.py new file mode 100644 index 00000000..f6d57bff --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template.py @@ -0,0 +1,227 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn + from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources + from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup + from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters + from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier + from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes + globals()['PACalculationColumn'] = PACalculationColumn + globals()['PACalculationDataSources'] = PACalculationDataSources + globals()['PACalculationGroup'] = PACalculationGroup + globals()['PADateParameters'] = PADateParameters + globals()['PAIdentifier'] = PAIdentifier + globals()['TemplateContentTypes'] = TemplateContentTypes + + +class UnlinkedPATemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'directory': (str,), # noqa: E501 + 'template_type_id': (str,), # noqa: E501 + 'snapshot': (bool,), # noqa: E501 + 'accounts': ([PAIdentifier],), # noqa: E501 + 'benchmarks': ([PAIdentifier],), # noqa: E501 + 'columns': ([PACalculationColumn],), # noqa: E501 + 'dates': (PADateParameters,), # noqa: E501 + 'groups': ([PACalculationGroup],), # noqa: E501 + 'datasources': (PACalculationDataSources,), # noqa: E501 + 'currencyisocode': (str,), # noqa: E501 + 'componentdetail': (str,), # noqa: E501 + 'content': (TemplateContentTypes,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'category': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'directory': 'directory', # noqa: E501 + 'template_type_id': 'templateTypeId', # noqa: E501 + 'snapshot': 'snapshot', # noqa: E501 + 'accounts': 'accounts', # noqa: E501 + 'benchmarks': 'benchmarks', # noqa: E501 + 'columns': 'columns', # noqa: E501 + 'dates': 'dates', # noqa: E501 + 'groups': 'groups', # noqa: E501 + 'datasources': 'datasources', # noqa: E501 + 'currencyisocode': 'currencyisocode', # noqa: E501 + 'componentdetail': 'componentdetail', # noqa: E501 + 'content': 'content', # noqa: E501 + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'category': 'category', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Template id.. [optional] # noqa: E501 + directory (str): Template directory.. [optional] # noqa: E501 + template_type_id (str): Template type id. [optional] # noqa: E501 + snapshot (bool): snapshot.. [optional] # noqa: E501 + accounts ([PAIdentifier]): List of accounts. [optional] # noqa: E501 + benchmarks ([PAIdentifier]): List of benchmarks. [optional] # noqa: E501 + columns ([PACalculationColumn]): List of columns for the PA calculation. [optional] # noqa: E501 + dates (PADateParameters): [optional] # noqa: E501 + groups ([PACalculationGroup]): List of groupings for the PA calculation. [optional] # noqa: E501 + datasources (PACalculationDataSources): [optional] # noqa: E501 + currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 + componentdetail (str): PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 + content (TemplateContentTypes): [optional] # noqa: E501 + description (str): Template description.. [optional] # noqa: E501 + name (str): Template name.. [optional] # noqa: E501 + category (str): Unlinked template category. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py new file mode 100644 index 00000000..ec303664 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type.py @@ -0,0 +1,170 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class UnlinkedPATemplateCategoryAndType(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'category': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'category': 'category', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateCategoryAndType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + category (str): Unlinked template category. [optional] # noqa: E501 + name (str): Unlinked template type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py new file mode 100644 index 00000000..799928d3 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details.py @@ -0,0 +1,189 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.unlinked_pa_template_column_details import UnlinkedPATemplateColumnDetails + from fds.analyticsapi.engines.model.unlinked_pa_template_group_details import UnlinkedPATemplateGroupDetails + globals()['UnlinkedPATemplateColumnDetails'] = UnlinkedPATemplateColumnDetails + globals()['UnlinkedPATemplateGroupDetails'] = UnlinkedPATemplateGroupDetails + + +class UnlinkedPATemplateCategoryAndTypeDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'columns': ([UnlinkedPATemplateColumnDetails],), # noqa: E501 + 'groups': ([UnlinkedPATemplateGroupDetails],), # noqa: E501 + 'snapshot': (bool,), # noqa: E501 + 'category': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'columns': 'columns', # noqa: E501 + 'groups': 'groups', # noqa: E501 + 'snapshot': 'snapshot', # noqa: E501 + 'category': 'category', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateCategoryAndTypeDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Type Id. [optional] # noqa: E501 + columns ([UnlinkedPATemplateColumnDetails]): List of default columns. [optional] # noqa: E501 + groups ([UnlinkedPATemplateGroupDetails]): List of default groupings. [optional] # noqa: E501 + snapshot (bool): Snapshot. [optional] # noqa: E501 + category (str): Unlinked template category. [optional] # noqa: E501 + name (str): Unlinked template type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py new file mode 100644 index 00000000..d4bda796 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_details_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details import UnlinkedPATemplateCategoryAndTypeDetails + globals()['UnlinkedPATemplateCategoryAndTypeDetails'] = UnlinkedPATemplateCategoryAndTypeDetails + + +class UnlinkedPATemplateCategoryAndTypeDetailsRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (UnlinkedPATemplateCategoryAndTypeDetails,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateCategoryAndTypeDetailsRoot - a model defined in OpenAPI + + Args: + data (UnlinkedPATemplateCategoryAndTypeDetails): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py new file mode 100644 index 00000000..7f3139c5 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_category_and_type_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type import UnlinkedPATemplateCategoryAndType + globals()['UnlinkedPATemplateCategoryAndType'] = UnlinkedPATemplateCategoryAndType + + +class UnlinkedPATemplateCategoryAndTypeRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (UnlinkedPATemplateCategoryAndType,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateCategoryAndTypeRoot - a model defined in OpenAPI + + Args: + data ({str: (UnlinkedPATemplateCategoryAndType,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py new file mode 100644 index 00000000..3bd64faa --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_column_details.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class UnlinkedPATemplateColumnDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'statistics': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'id': 'id', # noqa: E501 + 'statistics': 'statistics', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateColumnDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Unlinked template column name. [optional] # noqa: E501 + id (str): FactSet-defined or User-defined Column identifier.. [optional] # noqa: E501 + statistics ([str]): Column Statistic identifier. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py new file mode 100644 index 00000000..5793b5f8 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_group_details.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class UnlinkedPATemplateGroupDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'frequency': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'id': 'id', # noqa: E501 + 'frequency': 'frequency', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateGroupDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Unlinked template group name. [optional] # noqa: E501 + id (str): FactSet-defined or User-defined Group identifier.. [optional] # noqa: E501 + frequency (str): Grouping frequency. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py new file mode 100644 index 00000000..58d2d207 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters.py @@ -0,0 +1,219 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn + from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources + from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup + from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters + from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier + from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes + globals()['PACalculationColumn'] = PACalculationColumn + globals()['PACalculationDataSources'] = PACalculationDataSources + globals()['PACalculationGroup'] = PACalculationGroup + globals()['PADateParameters'] = PADateParameters + globals()['PAIdentifier'] = PAIdentifier + globals()['TemplateContentTypes'] = TemplateContentTypes + + +class UnlinkedPATemplateParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'directory': (str,), # noqa: E501 + 'template_type_id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'accounts': ([PAIdentifier],), # noqa: E501 + 'benchmarks': ([PAIdentifier],), # noqa: E501 + 'columns': ([PACalculationColumn],), # noqa: E501 + 'dates': (PADateParameters,), # noqa: E501 + 'groups': ([PACalculationGroup],), # noqa: E501 + 'datasources': (PACalculationDataSources,), # noqa: E501 + 'currencyisocode': (str,), # noqa: E501 + 'componentdetail': (str,), # noqa: E501 + 'content': (TemplateContentTypes,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'directory': 'directory', # noqa: E501 + 'template_type_id': 'templateTypeId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'accounts': 'accounts', # noqa: E501 + 'benchmarks': 'benchmarks', # noqa: E501 + 'columns': 'columns', # noqa: E501 + 'dates': 'dates', # noqa: E501 + 'groups': 'groups', # noqa: E501 + 'datasources': 'datasources', # noqa: E501 + 'currencyisocode': 'currencyisocode', # noqa: E501 + 'componentdetail': 'componentdetail', # noqa: E501 + 'content': 'content', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, directory, template_type_id, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateParameters - a model defined in OpenAPI + + Args: + directory (str): The directory to create an unlinked PA template + template_type_id (str): Template type id + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Template description. [optional] # noqa: E501 + accounts ([PAIdentifier]): List of accounts. [optional] # noqa: E501 + benchmarks ([PAIdentifier]): List of benchmarks. [optional] # noqa: E501 + columns ([PACalculationColumn]): List of columns for the PA calculation. [optional] # noqa: E501 + dates (PADateParameters): [optional] # noqa: E501 + groups ([PACalculationGroup]): List of groupings for the PA calculation. [optional] # noqa: E501 + datasources (PACalculationDataSources): [optional] # noqa: E501 + currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 + componentdetail (str): PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 + content (TemplateContentTypes): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.directory = directory + self.template_type_id = template_type_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py new file mode 100644 index 00000000..3e40030a --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_parameters_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.unlinked_pa_template_parameters import UnlinkedPATemplateParameters + globals()['UnlinkedPATemplateParameters'] = UnlinkedPATemplateParameters + + +class UnlinkedPATemplateParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (UnlinkedPATemplateParameters,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateParametersRoot - a model defined in OpenAPI + + Args: + data (UnlinkedPATemplateParameters): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py new file mode 100644 index 00000000..7c0790e6 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary.py @@ -0,0 +1,176 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class UnlinkedPATemplatePostSummary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'category': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'category': 'category', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplatePostSummary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Template id.. [optional] # noqa: E501 + description (str): Template description.. [optional] # noqa: E501 + name (str): Template name.. [optional] # noqa: E501 + category (str): Unlinked template category. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py new file mode 100644 index 00000000..e523979c --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_post_summary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary import UnlinkedPATemplatePostSummary + globals()['UnlinkedPATemplatePostSummary'] = UnlinkedPATemplatePostSummary + + +class UnlinkedPATemplatePostSummaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (UnlinkedPATemplatePostSummary,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplatePostSummaryRoot - a model defined in OpenAPI + + Args: + data (UnlinkedPATemplatePostSummary): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_root.py new file mode 100644 index 00000000..2199f5af --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.unlinked_pa_template import UnlinkedPATemplate + globals()['UnlinkedPATemplate'] = UnlinkedPATemplate + + +class UnlinkedPATemplateRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (UnlinkedPATemplate,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateRoot - a model defined in OpenAPI + + Args: + data (UnlinkedPATemplate): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary.py new file mode 100644 index 00000000..1cad6d39 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary.py @@ -0,0 +1,173 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class UnlinkedPATemplateSummary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'category': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + 'category': 'category', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateSummary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Template description.. [optional] # noqa: E501 + name (str): Template name.. [optional] # noqa: E501 + category (str): Unlinked template category. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py new file mode 100644 index 00000000..f786f561 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.unlinked_pa_template_summary import UnlinkedPATemplateSummary + globals()['UnlinkedPATemplateSummary'] = UnlinkedPATemplateSummary + + +class UnlinkedPATemplateSummaryRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ({str: (UnlinkedPATemplateSummary,)},), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateSummaryRoot - a model defined in OpenAPI + + Args: + data ({str: (UnlinkedPATemplateSummary,)}): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py new file mode 100644 index 00000000..bdc81b26 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py @@ -0,0 +1,209 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn + from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources + from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup + from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters + from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier + from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes + globals()['PACalculationColumn'] = PACalculationColumn + globals()['PACalculationDataSources'] = PACalculationDataSources + globals()['PACalculationGroup'] = PACalculationGroup + globals()['PADateParameters'] = PADateParameters + globals()['PAIdentifier'] = PAIdentifier + globals()['TemplateContentTypes'] = TemplateContentTypes + + +class UnlinkedPATemplateUpdateParameters(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'description': (str,), # noqa: E501 + 'accounts': ([PAIdentifier],), # noqa: E501 + 'benchmarks': ([PAIdentifier],), # noqa: E501 + 'columns': ([PACalculationColumn],), # noqa: E501 + 'dates': (PADateParameters,), # noqa: E501 + 'groups': ([PACalculationGroup],), # noqa: E501 + 'datasources': (PACalculationDataSources,), # noqa: E501 + 'currencyisocode': (str,), # noqa: E501 + 'componentdetail': (str,), # noqa: E501 + 'content': (TemplateContentTypes,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'accounts': 'accounts', # noqa: E501 + 'benchmarks': 'benchmarks', # noqa: E501 + 'columns': 'columns', # noqa: E501 + 'dates': 'dates', # noqa: E501 + 'groups': 'groups', # noqa: E501 + 'datasources': 'datasources', # noqa: E501 + 'currencyisocode': 'currencyisocode', # noqa: E501 + 'componentdetail': 'componentdetail', # noqa: E501 + 'content': 'content', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateUpdateParameters - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Template description. [optional] # noqa: E501 + accounts ([PAIdentifier]): List of accounts. [optional] # noqa: E501 + benchmarks ([PAIdentifier]): List of benchmarks. [optional] # noqa: E501 + columns ([PACalculationColumn]): List of columns for the PA calculation. [optional] # noqa: E501 + dates (PADateParameters): [optional] # noqa: E501 + groups ([PACalculationGroup]): List of groupings for the PA calculation. [optional] # noqa: E501 + datasources (PACalculationDataSources): [optional] # noqa: E501 + currencyisocode (str): Currency ISO code for calculation.. [optional] # noqa: E501 + componentdetail (str): PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES.. [optional] # noqa: E501 + content (TemplateContentTypes): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py new file mode 100644 index 00000000..26ccddc4 --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py @@ -0,0 +1,178 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters import UnlinkedPATemplateUpdateParameters + globals()['UnlinkedPATemplateUpdateParameters'] = UnlinkedPATemplateUpdateParameters + + +class UnlinkedPATemplateUpdateParametersRoot(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (UnlinkedPATemplateUpdateParameters,), # noqa: E501 + 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """UnlinkedPATemplateUpdateParametersRoot - a model defined in OpenAPI + + Args: + data (UnlinkedPATemplateUpdateParameters): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py index 29484259..6fa013ec 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py @@ -36,6 +36,12 @@ from fds.analyticsapi.engines.model.calculations_summary import CalculationsSummary from fds.analyticsapi.engines.model.calculations_summary_root import CalculationsSummaryRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse +from fds.analyticsapi.engines.model.column import Column +from fds.analyticsapi.engines.model.column_root import ColumnRoot +from fds.analyticsapi.engines.model.column_statistic import ColumnStatistic +from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot +from fds.analyticsapi.engines.model.column_summary import ColumnSummary +from fds.analyticsapi.engines.model.column_summary_root import ColumnSummaryRoot from fds.analyticsapi.engines.model.component_summary import ComponentSummary from fds.analyticsapi.engines.model.component_summary_root import ComponentSummaryRoot from fds.analyticsapi.engines.model.configuration_account import ConfigurationAccount @@ -78,8 +84,27 @@ from fds.analyticsapi.engines.model.fi_servicer_advances_for_securities import FIServicerAdvancesForSecurities from fds.analyticsapi.engines.model.fi_structured_products_for_job_settings import FIStructuredProductsForJobSettings from fds.analyticsapi.engines.model.fi_structured_products_for_securities import FIStructuredProductsForSecurities +from fds.analyticsapi.engines.model.fpo_account import FPOAccount +from fds.analyticsapi.engines.model.fpo_objective import FPOObjective +from fds.analyticsapi.engines.model.fpo_optimization_parameters import FPOOptimizationParameters +from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot +from fds.analyticsapi.engines.model.fpo_optimizer_strategy import FPOOptimizerStrategy +from fds.analyticsapi.engines.model.fpo_optimizer_strategy_overrides import FPOOptimizerStrategyOverrides from fds.analyticsapi.engines.model.frequency import Frequency from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot +from fds.analyticsapi.engines.model.group import Group +from fds.analyticsapi.engines.model.group_root import GroupRoot +from fds.analyticsapi.engines.model.linked_pa_template import LinkedPATemplate +from fds.analyticsapi.engines.model.linked_pa_template_parameters import LinkedPATemplateParameters +from fds.analyticsapi.engines.model.linked_pa_template_parameters_root import LinkedPATemplateParametersRoot +from fds.analyticsapi.engines.model.linked_pa_template_post_summary import LinkedPATemplatePostSummary +from fds.analyticsapi.engines.model.linked_pa_template_post_summary_root import LinkedPATemplatePostSummaryRoot +from fds.analyticsapi.engines.model.linked_pa_template_root import LinkedPATemplateRoot +from fds.analyticsapi.engines.model.linked_pa_template_summary import LinkedPATemplateSummary +from fds.analyticsapi.engines.model.linked_pa_template_summary_root import LinkedPATemplateSummaryRoot +from fds.analyticsapi.engines.model.linked_pa_template_update_parameters import LinkedPATemplateUpdateParameters +from fds.analyticsapi.engines.model.linked_pa_template_update_parameters_root import LinkedPATemplateUpdateParametersRoot +from fds.analyticsapi.engines.model.metadata import Metadata from fds.analyticsapi.engines.model.npo_optimization_parameters import NPOOptimizationParameters from fds.analyticsapi.engines.model.npo_optimization_parameters_root import NPOOptimizationParametersRoot from fds.analyticsapi.engines.model.npo_optimizer_strategy import NPOOptimizerStrategy @@ -92,6 +117,31 @@ from fds.analyticsapi.engines.model.optimizer_optimal_holdings import OptimizerOptimalHoldings from fds.analyticsapi.engines.model.optimizer_output_types import OptimizerOutputTypes from fds.analyticsapi.engines.model.optimizer_trades_list import OptimizerTradesList +from fds.analyticsapi.engines.model.pa_calculation_column import PACalculationColumn +from fds.analyticsapi.engines.model.pa_calculation_data_sources import PACalculationDataSources +from fds.analyticsapi.engines.model.pa_calculation_group import PACalculationGroup +from fds.analyticsapi.engines.model.pa_calculation_parameters import PACalculationParameters +from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot +from fds.analyticsapi.engines.model.pa_calculation_pricing_source import PACalculationPricingSource +from fds.analyticsapi.engines.model.pa_commentary import PACommentary +from fds.analyticsapi.engines.model.pa_commentary_configuration_summary import PACommentaryConfigurationSummary +from fds.analyticsapi.engines.model.pa_commentary_configuration_summary_root import PACommentaryConfigurationSummaryRoot +from fds.analyticsapi.engines.model.pa_commentary_date import PACommentaryDate +from fds.analyticsapi.engines.model.pa_commentary_get_status import PACommentaryGetStatus +from fds.analyticsapi.engines.model.pa_commentary_get_status_root import PACommentaryGetStatusRoot +from fds.analyticsapi.engines.model.pa_commentary_parameters import PACommentaryParameters +from fds.analyticsapi.engines.model.pa_commentary_parameters_root import PACommentaryParametersRoot +from fds.analyticsapi.engines.model.pa_commentary_root import PACommentaryRoot +from fds.analyticsapi.engines.model.pa_commentary_status import PACommentaryStatus +from fds.analyticsapi.engines.model.pa_commentary_status_root import PACommentaryStatusRoot +from fds.analyticsapi.engines.model.pa_component import PAComponent +from fds.analyticsapi.engines.model.pa_component_data import PAComponentData +from fds.analyticsapi.engines.model.pa_component_root import PAComponentRoot +from fds.analyticsapi.engines.model.pa_date_parameters import PADateParameters +from fds.analyticsapi.engines.model.pa_identifier import PAIdentifier +from fds.analyticsapi.engines.model.pa_pricing_source import PAPricingSource +from fds.analyticsapi.engines.model.pa_pricing_source_root import PAPricingSourceRoot +from fds.analyticsapi.engines.model.pa_doc import PaDoc from fds.analyticsapi.engines.model.pagination_info import PaginationInfo from fds.analyticsapi.engines.model.pagination_meta import PaginationMeta from fds.analyticsapi.engines.model.pub_calculation_parameters import PubCalculationParameters @@ -124,6 +174,34 @@ from fds.analyticsapi.engines.model.spar_component_root import SPARComponentRoot from fds.analyticsapi.engines.model.spar_date_parameters import SPARDateParameters from fds.analyticsapi.engines.model.spar_identifier import SPARIdentifier +from fds.analyticsapi.engines.model.section import Section +from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes +from fds.analyticsapi.engines.model.templated_pa_component import TemplatedPAComponent +from fds.analyticsapi.engines.model.templated_pa_component_parameters import TemplatedPAComponentParameters +from fds.analyticsapi.engines.model.templated_pa_component_parameters_root import TemplatedPAComponentParametersRoot +from fds.analyticsapi.engines.model.templated_pa_component_post_summary import TemplatedPAComponentPostSummary +from fds.analyticsapi.engines.model.templated_pa_component_post_summary_root import TemplatedPAComponentPostSummaryRoot +from fds.analyticsapi.engines.model.templated_pa_component_root import TemplatedPAComponentRoot +from fds.analyticsapi.engines.model.templated_pa_component_summary import TemplatedPAComponentSummary +from fds.analyticsapi.engines.model.templated_pa_component_summary_root import TemplatedPAComponentSummaryRoot +from fds.analyticsapi.engines.model.templated_pa_component_update_parameters import TemplatedPAComponentUpdateParameters +from fds.analyticsapi.engines.model.templated_pa_component_update_parameters_root import TemplatedPAComponentUpdateParametersRoot +from fds.analyticsapi.engines.model.unlinked_pa_template import UnlinkedPATemplate +from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type import UnlinkedPATemplateCategoryAndType +from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details import UnlinkedPATemplateCategoryAndTypeDetails +from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_details_root import UnlinkedPATemplateCategoryAndTypeDetailsRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_category_and_type_root import UnlinkedPATemplateCategoryAndTypeRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_column_details import UnlinkedPATemplateColumnDetails +from fds.analyticsapi.engines.model.unlinked_pa_template_group_details import UnlinkedPATemplateGroupDetails +from fds.analyticsapi.engines.model.unlinked_pa_template_parameters import UnlinkedPATemplateParameters +from fds.analyticsapi.engines.model.unlinked_pa_template_parameters_root import UnlinkedPATemplateParametersRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary import UnlinkedPATemplatePostSummary +from fds.analyticsapi.engines.model.unlinked_pa_template_post_summary_root import UnlinkedPATemplatePostSummaryRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_root import UnlinkedPATemplateRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_summary import UnlinkedPATemplateSummary +from fds.analyticsapi.engines.model.unlinked_pa_template_summary_root import UnlinkedPATemplateSummaryRoot +from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters import UnlinkedPATemplateUpdateParameters +from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters_root import UnlinkedPATemplateUpdateParametersRoot from fds.analyticsapi.engines.model.vault_attribution_loader_response import VaultAttributionLoaderResponse from fds.analyticsapi.engines.model.vault_attribution_loader_response_root import VaultAttributionLoaderResponseRoot from fds.analyticsapi.engines.model.vault_calculation_parameters import VaultCalculationParameters From 6fe3debdcbaf17dd5c3c393fee22c79e353e40f8 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 06:44:04 +0000 Subject: [PATCH 03/10] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.1.0 --- auto-generated-sdk/README.md | 2 +- auto-generated-sdk/fds/analyticsapi/engines/__init__.py | 2 +- auto-generated-sdk/fds/analyticsapi/engines/api_client.py | 2 +- auto-generated-sdk/fds/analyticsapi/engines/configuration.py | 2 +- auto-generated-sdk/setup.py | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index ef35a04f..77931191 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -4,7 +4,7 @@ Allow clients to fetch Analytics through APIs. This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] -- Package version: 6.1.0-rc.1 +- Package version: 6.1.0 - Build package: CustomPythonClientCodegen For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/__init__.py index 6ff3fa7d..0de57337 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/__init__.py @@ -11,7 +11,7 @@ """ -__version__ = "6.1.0-rc.1" +__version__ = "6.1.0" # import ApiClient from fds.analyticsapi.engines.api_client import ApiClient diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api_client.py b/auto-generated-sdk/fds/analyticsapi/engines/api_client.py index fb7dfe23..7ad492fd 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api_client.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api_client.py @@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'engines-api/6.1.0-rc.1/python' + self.user_agent = 'engines-api/6.1.0/python' def __enter__(self): return self diff --git a/auto-generated-sdk/fds/analyticsapi/engines/configuration.py b/auto-generated-sdk/fds/analyticsapi/engines/configuration.py index b9a17e02..8c950f44 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/configuration.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/configuration.py @@ -409,7 +409,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]\n"\ - "SDK Package Version: 6.1.0-rc.1".\ + "SDK Package Version: 6.1.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/auto-generated-sdk/setup.py b/auto-generated-sdk/setup.py index c122710d..968ace04 100644 --- a/auto-generated-sdk/setup.py +++ b/auto-generated-sdk/setup.py @@ -14,7 +14,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "fds.analyticsapi.engines" -VERSION = "6.1.0-rc.1" +VERSION = "6.1.0" # To install the library, run the following # # python setup.py install From 73edab7263fed8139e6a05a8af61e5d371a60c9b Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 09:57:14 +0000 Subject: [PATCH 04/10] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.1.0 --- auto-generated-sdk/.openapi-generator/FILES | 50 +-- auto-generated-sdk/README.md | 29 +- auto-generated-sdk/docs/AccountDirectories.md | 1 - auto-generated-sdk/docs/CalculationStatus.md | 1 - .../docs/CalculationStatusMeta.md | 3 +- .../docs/CalculationUnitStatus.md | 1 - .../docs/CalculationUnitStatusMeta.md | 1 - auto-generated-sdk/docs/ComponentsApi.md | 4 +- auto-generated-sdk/docs/ConfigurationsApi.md | 96 +---- auto-generated-sdk/docs/Currency.md | 1 - auto-generated-sdk/docs/FICalculationsApi.md | 18 +- .../docs/FIConvertibleSettings.md | 16 - auto-generated-sdk/docs/FISecurity.md | 1 - .../docs/LinkedPATemplatesApi.md | 2 +- auto-generated-sdk/docs/Metadata.md | 16 - auto-generated-sdk/docs/PACalculationsApi.md | 301 +------------ auto-generated-sdk/docs/PACommentary.md | 13 - .../PACommentaryConfigurationSummaryRoot.md | 12 - auto-generated-sdk/docs/PACommentaryDate.md | 12 - .../docs/PACommentaryGetStatus.md | 13 - auto-generated-sdk/docs/PACommentaryStatus.md | 14 - auto-generated-sdk/docs/PubCalculationsApi.md | 24 +- .../docs/QuantCalculationsApi.md | 2 +- .../docs/QuantDateListObsolete.md | 14 + ...ametersRoot.md => QuantFdsDateObsolete.md} | 9 +- ...mmary.md => QuantFqlExpressionObsolete.md} | 8 +- ....md => QuantIdentifierUniverseObsolete.md} | 7 +- ...md => QuantScreeningExpressionObsolete.md} | 7 +- ...antScreeningExpressionUniverseObsolete.md} | 8 +- ... QuantUniversalScreenParameterObsolete.md} | 5 +- .../QuantUniversalScreenUniverseObsolete.md | 12 + .../docs/SPARCalculationsApi.md | 4 +- auto-generated-sdk/docs/SPARDateParameters.md | 1 - auto-generated-sdk/docs/Section.md | 14 - .../docs/TemplatedPAComponentsApi.md | 4 +- .../docs/VaultAttributionLoaderApi.md | 112 ----- .../docs/VaultAttributionLoaderResponse.md | 13 - .../VaultAttributionLoaderResponseRoot.md | 12 - .../docs/VaultCalculationsApi.md | 2 +- .../engines/api/configurations_api.py | 121 ------ .../engines/api/fi_calculations_api.py | 4 +- .../engines/api/linked_pa_templates_api.py | 4 +- .../engines/api/pa_calculations_api.py | 405 +----------------- .../engines/api/pub_calculations_api.py | 23 +- .../engines/api/quant_calculations_api.py | 4 +- .../engines/api/spar_calculations_api.py | 4 +- .../api/templated_pa_components_api.py | 8 +- .../api/vault_attribution_loader_api.py | 168 -------- .../engines/api/vault_calculations_api.py | 4 +- .../fds/analyticsapi/engines/apis/__init__.py | 1 - .../engines/model/calculation_status_meta.py | 2 +- .../engines/model/fi_convertible_settings.py | 187 -------- .../analyticsapi/engines/model/fi_security.py | 5 - .../analyticsapi/engines/model/metadata.py | 187 -------- .../engines/model/pa_commentary_date.py | 170 -------- .../engines/model/pa_commentary_get_status.py | 177 -------- .../engines/model/pa_commentary_status.py | 180 -------- .../model/pa_commentary_status_root.py | 178 -------- ...mentary.py => quant_date_list_obsolete.py} | 36 +- ...tus_root.py => quant_fds_date_obsolete.py} | 37 +- ...ot.py => quant_fql_expression_obsolete.py} | 32 +- ... => quant_identifier_universe_obsolete.py} | 38 +- ...=> quant_screening_expression_obsolete.py} | 22 +- ..._screening_expression_universe_obsolete.py | 189 ++++++++ ...nt_universal_screen_parameter_obsolete.py} | 18 +- ...ant_universal_screen_universe_obsolete.py} | 30 +- .../fds/analyticsapi/engines/model/section.py | 181 -------- .../engines/model/spar_date_parameters.py | 3 - .../vault_attribution_loader_response.py | 173 -------- .../vault_attribution_loader_response_root.py | 178 -------- .../analyticsapi/engines/models/__init__.py | 24 +- 71 files changed, 458 insertions(+), 3198 deletions(-) delete mode 100644 auto-generated-sdk/docs/FIConvertibleSettings.md delete mode 100644 auto-generated-sdk/docs/Metadata.md delete mode 100644 auto-generated-sdk/docs/PACommentary.md delete mode 100644 auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md delete mode 100644 auto-generated-sdk/docs/PACommentaryDate.md delete mode 100644 auto-generated-sdk/docs/PACommentaryGetStatus.md delete mode 100644 auto-generated-sdk/docs/PACommentaryStatus.md create mode 100644 auto-generated-sdk/docs/QuantDateListObsolete.md rename auto-generated-sdk/docs/{PACommentaryParametersRoot.md => QuantFdsDateObsolete.md} (56%) rename auto-generated-sdk/docs/{PACommentaryConfigurationSummary.md => QuantFqlExpressionObsolete.md} (60%) rename auto-generated-sdk/docs/{PACommentaryRoot.md => QuantIdentifierUniverseObsolete.md} (62%) rename auto-generated-sdk/docs/{PACommentaryStatusRoot.md => QuantScreeningExpressionObsolete.md} (60%) rename auto-generated-sdk/docs/{PACommentaryGetStatusRoot.md => QuantScreeningExpressionUniverseObsolete.md} (58%) rename auto-generated-sdk/docs/{PACommentaryParameters.md => QuantUniversalScreenParameterObsolete.md} (73%) create mode 100644 auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md delete mode 100644 auto-generated-sdk/docs/Section.md delete mode 100644 auto-generated-sdk/docs/VaultAttributionLoaderApi.md delete mode 100644 auto-generated-sdk/docs/VaultAttributionLoaderResponse.md delete mode 100644 auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/api/vault_attribution_loader_api.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/fi_convertible_settings.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/metadata.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_date.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status_root.py rename auto-generated-sdk/fds/analyticsapi/engines/model/{pa_commentary.py => quant_date_list_obsolete.py} (87%) rename auto-generated-sdk/fds/analyticsapi/engines/model/{pa_commentary_get_status_root.py => quant_fds_date_obsolete.py} (85%) rename auto-generated-sdk/fds/analyticsapi/engines/model/{pa_commentary_parameters_root.py => quant_fql_expression_obsolete.py} (88%) rename auto-generated-sdk/fds/analyticsapi/engines/model/{pa_commentary_configuration_summary_root.py => quant_identifier_universe_obsolete.py} (85%) rename auto-generated-sdk/fds/analyticsapi/engines/model/{pa_commentary_parameters.py => quant_screening_expression_obsolete.py} (90%) create mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py rename auto-generated-sdk/fds/analyticsapi/engines/model/{pa_commentary_configuration_summary.py => quant_universal_screen_parameter_obsolete.py} (93%) rename auto-generated-sdk/fds/analyticsapi/engines/model/{pa_commentary_root.py => quant_universal_screen_universe_obsolete.py} (89%) delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/section.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response.py delete mode 100644 auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES index c6095b3f..7f8d455e 100644 --- a/auto-generated-sdk/.openapi-generator/FILES +++ b/auto-generated-sdk/.openapi-generator/FILES @@ -76,7 +76,6 @@ docs/FICalculationParameters.md docs/FICalculationParametersRoot.md docs/FICalculationsApi.md docs/FICashflows.md -docs/FIConvertibleSettings.md docs/FIDiscountCurveInfo.md docs/FIDiscountCurveInfoRoot.md docs/FIJobSettings.md @@ -117,7 +116,6 @@ docs/LinkedPATemplateSummaryRoot.md docs/LinkedPATemplateUpdateParameters.md docs/LinkedPATemplateUpdateParametersRoot.md docs/LinkedPATemplatesApi.md -docs/Metadata.md docs/NPOOptimizationParameters.md docs/NPOOptimizationParametersRoot.md docs/NPOOptimizerApi.md @@ -138,17 +136,6 @@ docs/PACalculationParameters.md docs/PACalculationParametersRoot.md docs/PACalculationPricingSource.md docs/PACalculationsApi.md -docs/PACommentary.md -docs/PACommentaryConfigurationSummary.md -docs/PACommentaryConfigurationSummaryRoot.md -docs/PACommentaryDate.md -docs/PACommentaryGetStatus.md -docs/PACommentaryGetStatusRoot.md -docs/PACommentaryParameters.md -docs/PACommentaryParametersRoot.md -docs/PACommentaryRoot.md -docs/PACommentaryStatus.md -docs/PACommentaryStatusRoot.md docs/PAComponent.md docs/PAComponentData.md docs/PAComponentRoot.md @@ -172,14 +159,22 @@ docs/QuantCalculationParametersRoot.md docs/QuantCalculationsApi.md docs/QuantDate.md docs/QuantDateList.md +docs/QuantDateListObsolete.md docs/QuantFdsDate.md +docs/QuantFdsDateObsolete.md docs/QuantFormula.md docs/QuantFqlExpression.md +docs/QuantFqlExpressionObsolete.md docs/QuantIdentifierUniverse.md +docs/QuantIdentifierUniverseObsolete.md docs/QuantScreeningExpression.md +docs/QuantScreeningExpressionObsolete.md docs/QuantScreeningExpressionUniverse.md +docs/QuantScreeningExpressionUniverseObsolete.md docs/QuantUniversalScreenParameter.md +docs/QuantUniversalScreenParameterObsolete.md docs/QuantUniversalScreenUniverse.md +docs/QuantUniversalScreenUniverseObsolete.md docs/QuantUniverse.md docs/ReturnType.md docs/SPARAccounts.md @@ -193,7 +188,6 @@ docs/SPARComponent.md docs/SPARComponentRoot.md docs/SPARDateParameters.md docs/SPARIdentifier.md -docs/Section.md docs/StrategyDocumentsApi.md docs/TemplateContentTypes.md docs/TemplatedPAComponent.md @@ -224,9 +218,6 @@ docs/UnlinkedPATemplateSummaryRoot.md docs/UnlinkedPATemplateUpdateParameters.md docs/UnlinkedPATemplateUpdateParametersRoot.md docs/UnlinkedPATemplatesApi.md -docs/VaultAttributionLoaderApi.md -docs/VaultAttributionLoaderResponse.md -docs/VaultAttributionLoaderResponseRoot.md docs/VaultCalculationParameters.md docs/VaultCalculationParametersRoot.md docs/VaultCalculationsApi.md @@ -270,7 +261,6 @@ fds/analyticsapi/engines/api/spar_calculations_api.py fds/analyticsapi/engines/api/strategy_documents_api.py fds/analyticsapi/engines/api/templated_pa_components_api.py fds/analyticsapi/engines/api/unlinked_pa_templates_api.py -fds/analyticsapi/engines/api/vault_attribution_loader_api.py fds/analyticsapi/engines/api/vault_calculations_api.py fds/analyticsapi/engines/api_client.py fds/analyticsapi/engines/apis/__init__.py @@ -330,7 +320,6 @@ fds/analyticsapi/engines/model/fi_bank_loans.py fds/analyticsapi/engines/model/fi_calculation_parameters.py fds/analyticsapi/engines/model/fi_calculation_parameters_root.py fds/analyticsapi/engines/model/fi_cashflows.py -fds/analyticsapi/engines/model/fi_convertible_settings.py fds/analyticsapi/engines/model/fi_discount_curve_info.py fds/analyticsapi/engines/model/fi_discount_curve_info_root.py fds/analyticsapi/engines/model/fi_job_settings.py @@ -372,7 +361,6 @@ fds/analyticsapi/engines/model/linked_pa_template_summary.py fds/analyticsapi/engines/model/linked_pa_template_summary_root.py fds/analyticsapi/engines/model/linked_pa_template_update_parameters.py fds/analyticsapi/engines/model/linked_pa_template_update_parameters_root.py -fds/analyticsapi/engines/model/metadata.py fds/analyticsapi/engines/model/npo_optimization_parameters.py fds/analyticsapi/engines/model/npo_optimization_parameters_root.py fds/analyticsapi/engines/model/npo_optimizer_strategy.py @@ -391,17 +379,6 @@ fds/analyticsapi/engines/model/pa_calculation_group.py fds/analyticsapi/engines/model/pa_calculation_parameters.py fds/analyticsapi/engines/model/pa_calculation_parameters_root.py fds/analyticsapi/engines/model/pa_calculation_pricing_source.py -fds/analyticsapi/engines/model/pa_commentary.py -fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py -fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py -fds/analyticsapi/engines/model/pa_commentary_date.py -fds/analyticsapi/engines/model/pa_commentary_get_status.py -fds/analyticsapi/engines/model/pa_commentary_get_status_root.py -fds/analyticsapi/engines/model/pa_commentary_parameters.py -fds/analyticsapi/engines/model/pa_commentary_parameters_root.py -fds/analyticsapi/engines/model/pa_commentary_root.py -fds/analyticsapi/engines/model/pa_commentary_status.py -fds/analyticsapi/engines/model/pa_commentary_status_root.py fds/analyticsapi/engines/model/pa_component.py fds/analyticsapi/engines/model/pa_component_data.py fds/analyticsapi/engines/model/pa_component_root.py @@ -422,17 +399,24 @@ fds/analyticsapi/engines/model/quant_calculation_parameters.py fds/analyticsapi/engines/model/quant_calculation_parameters_root.py fds/analyticsapi/engines/model/quant_date.py fds/analyticsapi/engines/model/quant_date_list.py +fds/analyticsapi/engines/model/quant_date_list_obsolete.py fds/analyticsapi/engines/model/quant_fds_date.py +fds/analyticsapi/engines/model/quant_fds_date_obsolete.py fds/analyticsapi/engines/model/quant_formula.py fds/analyticsapi/engines/model/quant_fql_expression.py +fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py fds/analyticsapi/engines/model/quant_identifier_universe.py +fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py fds/analyticsapi/engines/model/quant_screening_expression.py +fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py fds/analyticsapi/engines/model/quant_screening_expression_universe.py +fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py fds/analyticsapi/engines/model/quant_universal_screen_parameter.py +fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py fds/analyticsapi/engines/model/quant_universal_screen_universe.py +fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py fds/analyticsapi/engines/model/quant_universe.py fds/analyticsapi/engines/model/return_type.py -fds/analyticsapi/engines/model/section.py fds/analyticsapi/engines/model/spar_accounts.py fds/analyticsapi/engines/model/spar_accounts_root.py fds/analyticsapi/engines/model/spar_benchmark.py @@ -470,8 +454,6 @@ fds/analyticsapi/engines/model/unlinked_pa_template_summary.py fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py -fds/analyticsapi/engines/model/vault_attribution_loader_response.py -fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py fds/analyticsapi/engines/model/vault_calculation_parameters.py fds/analyticsapi/engines/model/vault_calculation_parameters_root.py fds/analyticsapi/engines/model/vault_component.py diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index 77931191..1259988c 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -127,7 +127,6 @@ Class | Method | HTTP request | Description *ComponentsApi* | [**get_spar_components**](docs/ComponentsApi.md#get_spar_components) | **GET** /analytics/engines/spar/v3/components | Get SPAR components *ComponentsApi* | [**get_vault_component_by_id**](docs/ComponentsApi.md#get_vault_component_by_id) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id *ComponentsApi* | [**get_vault_components**](docs/ComponentsApi.md#get_vault_components) | **GET** /analytics/engines/vault/v3/components | Get Vault components -*ConfigurationsApi* | [**get_pa_commentary_configurations**](docs/ConfigurationsApi.md#get_pa_commentary_configurations) | **GET** /analytics/engines/pa/v3/commentary/configurations | Get PA commentary configurations in a directory *ConfigurationsApi* | [**get_vault_configuration_by_id**](docs/ConfigurationsApi.md#get_vault_configuration_by_id) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id *ConfigurationsApi* | [**get_vault_configurations**](docs/ConfigurationsApi.md#get_vault_configurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations *CurrenciesApi* | [**get_currencies**](docs/CurrenciesApi.md#get_currencies) | **GET** /analytics/lookups/v3/currencies | Get currencies @@ -170,13 +169,10 @@ Class | Method | HTTP request | Description *NPOOptimizerApi* | [**post_and_optimize**](docs/NPOOptimizerApi.md#post_and_optimize) | **POST** /analytics/engines/npo/v3/optimizations | Create and Run NPO optimization *NPOOptimizerApi* | [**put_and_optimize**](docs/NPOOptimizerApi.md#put_and_optimize) | **PUT** /analytics/engines/npo/v3/optimizations/{id} | Create or Update NPO optimization and run it. *PACalculationsApi* | [**cancel_calculation_by_id**](docs/PACalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id -*PACalculationsApi* | [**generate_pa_portfolio_commentary**](docs/PACalculationsApi.md#generate_pa_portfolio_commentary) | **POST** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary | Generate PA portfolio commentary by calculation and unit id. *PACalculationsApi* | [**get_all_calculations**](docs/PACalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations *PACalculationsApi* | [**get_calculation_parameters**](docs/PACalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id *PACalculationsApi* | [**get_calculation_status_by_id**](docs/PACalculationsApi.md#get_calculation_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id *PACalculationsApi* | [**get_calculation_unit_result_by_id**](docs/PACalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id -*PACalculationsApi* | [**get_pa_portfolio_commentary_result_by_id**](docs/PACalculationsApi.md#get_pa_portfolio_commentary_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result | Get PA Portfolio commentary result by calculation and unit id. -*PACalculationsApi* | [**get_pa_portfolio_commentary_status_by_id**](docs/PACalculationsApi.md#get_pa_portfolio_commentary_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status | Get PA portfolio commentary status by calculation and unit id. *PACalculationsApi* | [**post_and_calculate**](docs/PACalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation *PACalculationsApi* | [**put_and_calculate**](docs/PACalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. *PricingSourcesApi* | [**get_pa_pricing_sources**](docs/PricingSourcesApi.md#get_pa_pricing_sources) | **GET** /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources @@ -226,7 +222,6 @@ Class | Method | HTTP request | Description *VaultCalculationsApi* | [**get_calculation_unit_result_by_id**](docs/VaultCalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result | Get Vault calculation result by id *VaultCalculationsApi* | [**post_and_calculate**](docs/VaultCalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/vault/v3/calculations | Create and Run Vault calculation *VaultCalculationsApi* | [**put_and_calculate**](docs/VaultCalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/vault/v3/calculations/{id} | Create or Update Vault calculation and run it. -*VaultAttributionLoaderApi* | [**vault_attribution_loader**](docs/VaultAttributionLoaderApi.md#vault_attribution_loader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader ## Documentation For Models @@ -289,7 +284,6 @@ Class | Method | HTTP request | Description - [FICalculationParameters](docs/FICalculationParameters.md) - [FICalculationParametersRoot](docs/FICalculationParametersRoot.md) - [FICashflows](docs/FICashflows.md) - - [FIConvertibleSettings](docs/FIConvertibleSettings.md) - [FIDiscountCurveInfo](docs/FIDiscountCurveInfo.md) - [FIDiscountCurveInfoRoot](docs/FIDiscountCurveInfoRoot.md) - [FIJobSettings](docs/FIJobSettings.md) @@ -326,7 +320,6 @@ Class | Method | HTTP request | Description - [LinkedPATemplateSummaryRoot](docs/LinkedPATemplateSummaryRoot.md) - [LinkedPATemplateUpdateParameters](docs/LinkedPATemplateUpdateParameters.md) - [LinkedPATemplateUpdateParametersRoot](docs/LinkedPATemplateUpdateParametersRoot.md) - - [Metadata](docs/Metadata.md) - [NPOOptimizationParameters](docs/NPOOptimizationParameters.md) - [NPOOptimizationParametersRoot](docs/NPOOptimizationParametersRoot.md) - [NPOOptimizerStrategy](docs/NPOOptimizerStrategy.md) @@ -345,17 +338,6 @@ Class | Method | HTTP request | Description - [PACalculationParameters](docs/PACalculationParameters.md) - [PACalculationParametersRoot](docs/PACalculationParametersRoot.md) - [PACalculationPricingSource](docs/PACalculationPricingSource.md) - - [PACommentary](docs/PACommentary.md) - - [PACommentaryConfigurationSummary](docs/PACommentaryConfigurationSummary.md) - - [PACommentaryConfigurationSummaryRoot](docs/PACommentaryConfigurationSummaryRoot.md) - - [PACommentaryDate](docs/PACommentaryDate.md) - - [PACommentaryGetStatus](docs/PACommentaryGetStatus.md) - - [PACommentaryGetStatusRoot](docs/PACommentaryGetStatusRoot.md) - - [PACommentaryParameters](docs/PACommentaryParameters.md) - - [PACommentaryParametersRoot](docs/PACommentaryParametersRoot.md) - - [PACommentaryRoot](docs/PACommentaryRoot.md) - - [PACommentaryStatus](docs/PACommentaryStatus.md) - - [PACommentaryStatusRoot](docs/PACommentaryStatusRoot.md) - [PAComponent](docs/PAComponent.md) - [PAComponentData](docs/PAComponentData.md) - [PAComponentRoot](docs/PAComponentRoot.md) @@ -376,14 +358,22 @@ Class | Method | HTTP request | Description - [QuantCalculationParametersRoot](docs/QuantCalculationParametersRoot.md) - [QuantDate](docs/QuantDate.md) - [QuantDateList](docs/QuantDateList.md) + - [QuantDateListObsolete](docs/QuantDateListObsolete.md) - [QuantFdsDate](docs/QuantFdsDate.md) + - [QuantFdsDateObsolete](docs/QuantFdsDateObsolete.md) - [QuantFormula](docs/QuantFormula.md) - [QuantFqlExpression](docs/QuantFqlExpression.md) + - [QuantFqlExpressionObsolete](docs/QuantFqlExpressionObsolete.md) - [QuantIdentifierUniverse](docs/QuantIdentifierUniverse.md) + - [QuantIdentifierUniverseObsolete](docs/QuantIdentifierUniverseObsolete.md) - [QuantScreeningExpression](docs/QuantScreeningExpression.md) + - [QuantScreeningExpressionObsolete](docs/QuantScreeningExpressionObsolete.md) - [QuantScreeningExpressionUniverse](docs/QuantScreeningExpressionUniverse.md) + - [QuantScreeningExpressionUniverseObsolete](docs/QuantScreeningExpressionUniverseObsolete.md) - [QuantUniversalScreenParameter](docs/QuantUniversalScreenParameter.md) + - [QuantUniversalScreenParameterObsolete](docs/QuantUniversalScreenParameterObsolete.md) - [QuantUniversalScreenUniverse](docs/QuantUniversalScreenUniverse.md) + - [QuantUniversalScreenUniverseObsolete](docs/QuantUniversalScreenUniverseObsolete.md) - [QuantUniverse](docs/QuantUniverse.md) - [ReturnType](docs/ReturnType.md) - [SPARAccounts](docs/SPARAccounts.md) @@ -396,7 +386,6 @@ Class | Method | HTTP request | Description - [SPARComponentRoot](docs/SPARComponentRoot.md) - [SPARDateParameters](docs/SPARDateParameters.md) - [SPARIdentifier](docs/SPARIdentifier.md) - - [Section](docs/Section.md) - [TemplateContentTypes](docs/TemplateContentTypes.md) - [TemplatedPAComponent](docs/TemplatedPAComponent.md) - [TemplatedPAComponentParameters](docs/TemplatedPAComponentParameters.md) @@ -424,8 +413,6 @@ Class | Method | HTTP request | Description - [UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md) - [UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md) - [UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md) - - [VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md) - - [VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md) - [VaultCalculationParameters](docs/VaultCalculationParameters.md) - [VaultCalculationParametersRoot](docs/VaultCalculationParametersRoot.md) - [VaultComponent](docs/VaultComponent.md) diff --git a/auto-generated-sdk/docs/AccountDirectories.md b/auto-generated-sdk/docs/AccountDirectories.md index 48b6a59f..d05408be 100644 --- a/auto-generated-sdk/docs/AccountDirectories.md +++ b/auto-generated-sdk/docs/AccountDirectories.md @@ -1,6 +1,5 @@ # AccountDirectories -List of the accounts and directories. ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/CalculationStatus.md b/auto-generated-sdk/docs/CalculationStatus.md index 5b242ac3..6dba1313 100644 --- a/auto-generated-sdk/docs/CalculationStatus.md +++ b/auto-generated-sdk/docs/CalculationStatus.md @@ -1,6 +1,5 @@ # CalculationStatus -Details of the calculation. ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/CalculationStatusMeta.md b/auto-generated-sdk/docs/CalculationStatusMeta.md index 513749fd..0bf11b2d 100644 --- a/auto-generated-sdk/docs/CalculationStatusMeta.md +++ b/auto-generated-sdk/docs/CalculationStatusMeta.md @@ -1,11 +1,10 @@ # CalculationStatusMeta -Meta of calculation units in batch. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**units** | [**{str: (CalculationUnitStatusMeta,)}**](CalculationUnitStatusMeta.md) | List of calculation units in batch. | [optional] +**units** | [**{str: (CalculationUnitStatusMeta,)}**](CalculationUnitStatusMeta.md) | Meta of calculation units in batch. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md index c9891da8..f0968651 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatus.md +++ b/auto-generated-sdk/docs/CalculationUnitStatus.md @@ -1,6 +1,5 @@ # CalculationUnitStatus -The status of the calculation as per FactSets API standards ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/CalculationUnitStatusMeta.md b/auto-generated-sdk/docs/CalculationUnitStatusMeta.md index 2aff1bf1..7700622c 100644 --- a/auto-generated-sdk/docs/CalculationUnitStatusMeta.md +++ b/auto-generated-sdk/docs/CalculationUnitStatusMeta.md @@ -1,6 +1,5 @@ # CalculationUnitStatusMeta -Meta of the calculation unit. ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md index 7d23bd1b..26a2b66c 100644 --- a/auto-generated-sdk/docs/ComponentsApi.md +++ b/auto-generated-sdk/docs/ComponentsApi.md @@ -425,7 +425,7 @@ configuration = fds.analyticsapi.engines.Configuration( with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = components_api.ComponentsApi(api_client) - id = "AFB43C61A6651B87988FEA62ED333638595AE7D8D7345A33AB9994CF23AFCC5D" # str | Unique identifier for a vault component + id = "id_example" # str | Unique identifier for a vault component # example passing only required values which don't have defaults set try: @@ -517,7 +517,7 @@ configuration = fds.analyticsapi.engines.Configuration( with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = components_api.ComponentsApi(api_client) - document = "CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT" # str | Document Name + document = "document_example" # str | Document Name # example passing only required values which don't have defaults set try: diff --git a/auto-generated-sdk/docs/ConfigurationsApi.md b/auto-generated-sdk/docs/ConfigurationsApi.md index 65f5f92c..e69e4abe 100644 --- a/auto-generated-sdk/docs/ConfigurationsApi.md +++ b/auto-generated-sdk/docs/ConfigurationsApi.md @@ -5,102 +5,10 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_pa_commentary_configurations**](ConfigurationsApi.md#get_pa_commentary_configurations) | **GET** /analytics/engines/pa/v3/commentary/configurations | Get PA commentary configurations in a directory [**get_vault_configuration_by_id**](ConfigurationsApi.md#get_vault_configuration_by_id) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id [**get_vault_configurations**](ConfigurationsApi.md#get_vault_configurations) | **GET** /analytics/engines/vault/v3/configurations | Get Vault configurations -# **get_pa_commentary_configurations** -> PACommentaryConfigurationSummaryRoot get_pa_commentary_configurations(path) - -Get PA commentary configurations in a directory - -This endpoint returns all PA commentary configurations in a given directory. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import configurations_api -from fds.analyticsapi.engines.model.pa_commentary_configuration_summary_root import PACommentaryConfigurationSummaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = configurations_api.ConfigurationsApi(api_client) - path = "Client:" # str | The directory to get the PA commentary configurations - - # example passing only required values which don't have defaults set - try: - # Get PA commentary configurations in a directory - api_response = api_instance.get_pa_commentary_configurations(path) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling ConfigurationsApi->get_pa_commentary_configurations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path** | **str**| The directory to get the PA commentary configurations | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**PACommentaryConfigurationSummaryRoot**](PACommentaryConfigurationSummaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a map of configuration ID to PA commentary 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid path provided | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in 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.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_vault_configuration_by_id** > VaultConfigurationRoot get_vault_configuration_by_id(id) @@ -145,7 +53,7 @@ configuration = fds.analyticsapi.engines.Configuration( with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = configurations_api.ConfigurationsApi(api_client) - id = "e95ef921-b4d4-4bb7-93ba-60eca8e3247a" # str | Vault configuration id to get the details of + id = "id_example" # str | Vault configuration id to get the details of # example passing only required values which don't have defaults set try: @@ -237,7 +145,7 @@ configuration = fds.analyticsapi.engines.Configuration( with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = configurations_api.ConfigurationsApi(api_client) - account = "CLIENT:/MAC/DEMO/DEMO_PS_EQ_EM_COUNTRY_ALPHA.ACCT" # str | Required account query parameter to filter configurations for a specific account + account = "account_example" # str | Required account query parameter to filter configurations for a specific account # example passing only required values which don't have defaults set try: diff --git a/auto-generated-sdk/docs/Currency.md b/auto-generated-sdk/docs/Currency.md index 88408ae9..ed1ec221 100644 --- a/auto-generated-sdk/docs/Currency.md +++ b/auto-generated-sdk/docs/Currency.md @@ -1,6 +1,5 @@ # Currency -Details of the currency. ## Properties Name | Type | Description | Notes diff --git a/auto-generated-sdk/docs/FICalculationsApi.md b/auto-generated-sdk/docs/FICalculationsApi.md index 1328c54c..065f14e6 100644 --- a/auto-generated-sdk/docs/FICalculationsApi.md +++ b/auto-generated-sdk/docs/FICalculationsApi.md @@ -85,7 +85,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details @@ -484,14 +484,6 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: end_spread=3.14, pricing_method="Inputted Price", ), - convertible=FIConvertibleSettings( - equity_price=3.14, - equity_index_volatility=3.14, - equity_dividend_yield=3.14, - volatility_cap_method="noCap", - volatility_cap_method_value=3.14, - equity_exchange_rate=3.14, - ), calc_from_method="calc_from_method_example", calc_from_value=3.14, face=1, @@ -723,14 +715,6 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: end_spread=3.14, pricing_method="Inputted Price", ), - convertible=FIConvertibleSettings( - equity_price=3.14, - equity_index_volatility=3.14, - equity_dividend_yield=3.14, - volatility_cap_method="noCap", - volatility_cap_method_value=3.14, - equity_exchange_rate=3.14, - ), calc_from_method="calc_from_method_example", calc_from_value=3.14, face=1, diff --git a/auto-generated-sdk/docs/FIConvertibleSettings.md b/auto-generated-sdk/docs/FIConvertibleSettings.md deleted file mode 100644 index 25d3f2d7..00000000 --- a/auto-generated-sdk/docs/FIConvertibleSettings.md +++ /dev/null @@ -1,16 +0,0 @@ -# FIConvertibleSettings - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**equity_price** | **float** | Equity Price | [optional] -**equity_index_volatility** | **float** | Equity Index Volatility | [optional] -**equity_dividend_yield** | **float** | Equity Dividend Yield | [optional] -**volatility_cap_method** | **str** | Volatility CapMethod | [optional] -**volatility_cap_method_value** | **float** | Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier) | [optional] -**equity_exchange_rate** | **float** | Equity Exchange Rate | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/FISecurity.md b/auto-generated-sdk/docs/FISecurity.md index efa31ab6..dc760568 100644 --- a/auto-generated-sdk/docs/FISecurity.md +++ b/auto-generated-sdk/docs/FISecurity.md @@ -17,7 +17,6 @@ Name | Type | Description | Notes **matrix_multiplier** | **float** | Matrix Multiplier | [optional] **structured_products** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) | | [optional] **attribution** | [**FIAttributionForSecurities**](FIAttributionForSecurities.md) | | [optional] -**convertible** | [**FIConvertibleSettings**](FIConvertibleSettings.md) | | [optional] **calc_from_method** | **str** | Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix | [optional] **face** | **float** | Face | [optional] if omitted the server will use the default value of 1 **face_type** | **str** | Face type | [optional] if omitted the server will use the default value of "Current" diff --git a/auto-generated-sdk/docs/LinkedPATemplatesApi.md b/auto-generated-sdk/docs/LinkedPATemplatesApi.md index 43178503..326451ed 100644 --- a/auto-generated-sdk/docs/LinkedPATemplatesApi.md +++ b/auto-generated-sdk/docs/LinkedPATemplatesApi.md @@ -195,7 +195,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details diff --git a/auto-generated-sdk/docs/Metadata.md b/auto-generated-sdk/docs/Metadata.md deleted file mode 100644 index 50fa4848..00000000 --- a/auto-generated-sdk/docs/Metadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# Metadata - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tile_name** | **str** | PA Tile name associated with the component | [optional] -**portfolio_description** | **str** | Portfolio name used in generating commentary | [optional] -**benchmark_description** | **str** | Benchmark name used in generating commentary | [optional] -**start_date** | [**PACommentaryDate**](PACommentaryDate.md) | | [optional] -**end_date** | [**PACommentaryDate**](PACommentaryDate.md) | | [optional] -**frequency** | **str** | Date frequency | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACalculationsApi.md b/auto-generated-sdk/docs/PACalculationsApi.md index 6e2fed56..3d7f0cc9 100644 --- a/auto-generated-sdk/docs/PACalculationsApi.md +++ b/auto-generated-sdk/docs/PACalculationsApi.md @@ -6,13 +6,10 @@ All URIs are relative to *https://api.factset.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**cancel_calculation_by_id**](PACalculationsApi.md#cancel_calculation_by_id) | **DELETE** /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id -[**generate_pa_portfolio_commentary**](PACalculationsApi.md#generate_pa_portfolio_commentary) | **POST** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary | Generate PA portfolio commentary by calculation and unit id. [**get_all_calculations**](PACalculationsApi.md#get_all_calculations) | **GET** /analytics/engines/pa/v3/calculations | Get all calculations [**get_calculation_parameters**](PACalculationsApi.md#get_calculation_parameters) | **GET** /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id [**get_calculation_status_by_id**](PACalculationsApi.md#get_calculation_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id [**get_calculation_unit_result_by_id**](PACalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id -[**get_pa_portfolio_commentary_result_by_id**](PACalculationsApi.md#get_pa_portfolio_commentary_result_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result | Get PA Portfolio commentary result by calculation and unit id. -[**get_pa_portfolio_commentary_status_by_id**](PACalculationsApi.md#get_pa_portfolio_commentary_status_by_id) | **GET** /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status | Get PA portfolio commentary status by calculation and unit id. [**post_and_calculate**](PACalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/pa/v3/calculations | Create and Run PA calculation [**put_and_calculate**](PACalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. @@ -89,7 +86,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details @@ -105,118 +102,6 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **generate_pa_portfolio_commentary** -> PACommentaryRoot generate_pa_portfolio_commentary(id, unit_id) - -Generate PA portfolio commentary by calculation and unit id. - -This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. Remarks: * The PA component used in the calculation must be an attribution tile. * The \"Variation in Average Weight\" column must be included along with those required as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) in the component for successful commentary generation; otherwise, the request will result in an error. * PA portfolio commentary generation is not supported for multi-port requests. * The POST calculation must use a single portfolio and a benchmark to generate the commentary. * PA portfolio commentary with sub-period analysis will be returned only when the frequency is set to something other than \"single\" and the report contains more than one sub-period. * Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. If the configuration ID is not specified, the default commentary will be returned. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.pa_commentary_get_status_root import PACommentaryGetStatusRoot -from fds.analyticsapi.engines.model.pa_commentary_parameters_root import PACommentaryParametersRoot -from fds.analyticsapi.engines.model.pa_commentary_root import PACommentaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - id = "id_example" # str | Successful calculation id - unit_id = "unitId_example" # str | Unit id associated with the successful calculation id - pa_commentary_parameters_root = PACommentaryParametersRoot( - data=PACommentaryParameters( - configurationid="configurationid_example", - ), - meta=None, - ) # PACommentaryParametersRoot | Request Parameters (optional) - - # example passing only required values which don't have defaults set - try: - # Generate PA portfolio commentary by calculation and unit id. - api_response = api_instance.generate_pa_portfolio_commentary(id, unit_id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->generate_pa_portfolio_commentary: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Generate PA portfolio commentary by calculation and unit id. - api_response = api_instance.generate_pa_portfolio_commentary(id, unit_id, pa_commentary_parameters_root=pa_commentary_parameters_root) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->generate_pa_portfolio_commentary: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Successful calculation id | - **unit_id** | **str**| Unit id associated with the successful calculation id | - **pa_commentary_parameters_root** | [**PACommentaryParametersRoot**](PACommentaryParametersRoot.md)| Request Parameters | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 201 status - [**PACommentaryRoot**](PACommentaryRoot.md))(For 202 status - [**PACommentaryGetStatusRoot**](PACommentaryGetStatusRoot.md)) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Expected response if the commentary generation is completed in a short span, returns JSON. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting commentary
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_all_calculations** > CalculationsSummaryRoot get_all_calculations() @@ -583,190 +468,6 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_pa_portfolio_commentary_result_by_id** -> PACommentaryRoot get_pa_portfolio_commentary_result_by_id(id, unit_id) - -Get PA Portfolio commentary result by calculation and unit id. - -This endpoint retrieves the result of a previously requested portfolio commentary. If the commentary generation is complete, the commentary will be returned in a predefined JSON format. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.pa_commentary_root import PACommentaryRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - id = "id_example" # str | Successful calculation id - unit_id = "unitId_example" # str | Unit id associated with the successful calculation id - - # example passing only required values which don't have defaults set - try: - # Get PA Portfolio commentary result by calculation and unit id. - api_response = api_instance.get_pa_portfolio_commentary_result_by_id(id, unit_id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->get_pa_portfolio_commentary_result_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Successful calculation id | - **unit_id** | **str**| Unit id associated with the successful calculation id | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**PACommentaryRoot**](PACommentaryRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response once the commentary generation is completed, returns JSON. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pa_portfolio_commentary_status_by_id** -> PACommentaryStatusRoot get_pa_portfolio_commentary_status_by_id(id, unit_id) - -Get PA portfolio commentary status by calculation and unit id. - -This endpoint allows you to check the progress of a previously requested PA portfolio commentary. If the commentary generation is complete, the location header will provide the URL for the result. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import pa_calculations_api -from fds.analyticsapi.engines.model.pa_commentary_get_status_root import PACommentaryGetStatusRoot -from fds.analyticsapi.engines.model.pa_commentary_status_root import PACommentaryStatusRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = pa_calculations_api.PACalculationsApi(api_client) - id = "id_example" # str | Successful calculation id - unit_id = "unitId_example" # str | Unit id associated with the successful calculation id - - # example passing only required values which don't have defaults set - try: - # Get PA portfolio commentary status by calculation and unit id. - api_response = api_instance.get_pa_portfolio_commentary_status_by_id(id, unit_id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling PACalculationsApi->get_pa_portfolio_commentary_status_by_id: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| Successful calculation id | - **unit_id** | **str**| Unit id associated with the successful calculation id | - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 200 status - [**PACommentaryStatusRoot**](PACommentaryStatusRoot.md))(For 202 status - [**PACommentaryGetStatusRoot**](PACommentaryGetStatusRoot.md)) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response once commentary is completed. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**202** | Expected response returned if the commentary generation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **post_and_calculate** > CalculationStatusRoot post_and_calculate() diff --git a/auto-generated-sdk/docs/PACommentary.md b/auto-generated-sdk/docs/PACommentary.md deleted file mode 100644 index 25d9f9aa..00000000 --- a/auto-generated-sdk/docs/PACommentary.md +++ /dev/null @@ -1,13 +0,0 @@ -# PACommentary - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**commentary_id** | **str** | Generated commentary Id | [optional] -**sections** | [**[Section]**](Section.md) | Commentary sections | [optional] -**disclaimer** | **str** | Disclaimer | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md b/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md deleted file mode 100644 index debde525..00000000 --- a/auto-generated-sdk/docs/PACommentaryConfigurationSummaryRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# PACommentaryConfigurationSummaryRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**{str: (PACommentaryConfigurationSummary,)}**](PACommentaryConfigurationSummary.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACommentaryDate.md b/auto-generated-sdk/docs/PACommentaryDate.md deleted file mode 100644 index 1a7c0c12..00000000 --- a/auto-generated-sdk/docs/PACommentaryDate.md +++ /dev/null @@ -1,12 +0,0 @@ -# PACommentaryDate - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**yyyymmdd** | **int** | Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time. | [optional] -**relative** | **str** | Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACommentaryGetStatus.md b/auto-generated-sdk/docs/PACommentaryGetStatus.md deleted file mode 100644 index f4cf3d49..00000000 --- a/auto-generated-sdk/docs/PACommentaryGetStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# PACommentaryGetStatus - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**calculationid** | **str** | Calculation id. | [optional] -**unitid** | **str** | Calculation unit id. | [optional] -**status** | **str** | The status of commentary generation. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PACommentaryStatus.md b/auto-generated-sdk/docs/PACommentaryStatus.md deleted file mode 100644 index 364007aa..00000000 --- a/auto-generated-sdk/docs/PACommentaryStatus.md +++ /dev/null @@ -1,14 +0,0 @@ -# PACommentaryStatus - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**result** | **str** | The result url of the generated commentary. | [optional] -**calculationid** | **str** | Calculation id. | [optional] -**unitid** | **str** | Calculation unit id. | [optional] -**status** | **str** | The status of commentary generation. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/PubCalculationsApi.md b/auto-generated-sdk/docs/PubCalculationsApi.md index b47ea54c..2e0dfef0 100644 --- a/auto-generated-sdk/docs/PubCalculationsApi.md +++ b/auto-generated-sdk/docs/PubCalculationsApi.md @@ -86,7 +86,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details @@ -451,7 +451,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/json + - **Accept**: application/json, application/x-protobuf, application/pdf ### HTTP response details @@ -459,9 +459,9 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Expected response once calculation is completed, returns result in the format specified in the Calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| @@ -553,7 +553,7 @@ Name | Type | Description | Notes ### Return type - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) + - **Response datatype**: (For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File ) ### Authorization @@ -562,19 +562,19 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation + - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| +**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **400** | Invalid calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| @@ -678,7 +678,7 @@ Name | Type | Description | Notes ### Return type - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: (For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File )(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md)) + - **Response datatype**: (For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - File ) ### Authorization @@ -687,20 +687,20 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation + - **Accept**: application/pdf ### 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **400** | Invalid Calculation Parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* 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-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* 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/QuantCalculationsApi.md b/auto-generated-sdk/docs/QuantCalculationsApi.md index 45cbef11..81254f68 100644 --- a/auto-generated-sdk/docs/QuantCalculationsApi.md +++ b/auto-generated-sdk/docs/QuantCalculationsApi.md @@ -87,7 +87,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details diff --git a/auto-generated-sdk/docs/QuantDateListObsolete.md b/auto-generated-sdk/docs/QuantDateListObsolete.md new file mode 100644 index 00000000..38769883 --- /dev/null +++ b/auto-generated-sdk/docs/QuantDateListObsolete.md @@ -0,0 +1,14 @@ +# QuantDateListObsolete + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**frequency** | **str** | | +**calendar** | **str** | | +**dates** | **[str]** | | [optional] +**override_universal_screen_calendar** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/PACommentaryParametersRoot.md b/auto-generated-sdk/docs/QuantFdsDateObsolete.md similarity index 56% rename from auto-generated-sdk/docs/PACommentaryParametersRoot.md rename to auto-generated-sdk/docs/QuantFdsDateObsolete.md index b91c8507..6d9504f0 100644 --- a/auto-generated-sdk/docs/PACommentaryParametersRoot.md +++ b/auto-generated-sdk/docs/QuantFdsDateObsolete.md @@ -1,11 +1,14 @@ -# PACommentaryParametersRoot +# QuantFdsDateObsolete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PACommentaryParameters**](PACommentaryParameters.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**start_date** | **str** | | +**end_date** | **str** | | +**frequency** | **str** | | +**calendar** | **str** | | +**override_universal_screen_calendar** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md b/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md similarity index 60% rename from auto-generated-sdk/docs/PACommentaryConfigurationSummary.md rename to auto-generated-sdk/docs/QuantFqlExpressionObsolete.md index fdd9a428..901dc206 100644 --- a/auto-generated-sdk/docs/PACommentaryConfigurationSummary.md +++ b/auto-generated-sdk/docs/QuantFqlExpressionObsolete.md @@ -1,11 +1,13 @@ -# PACommentaryConfigurationSummary +# QuantFqlExpressionObsolete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | PA commentary configuration name | [optional] -**directory** | **str** | PA Commentary configuration directory | [optional] +**expr** | **str** | | +**name** | **str** | | +**date_offset** | **str** | | [optional] +**is_array_return_type** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/PACommentaryRoot.md b/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md similarity index 62% rename from auto-generated-sdk/docs/PACommentaryRoot.md rename to auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md index 85cbffc2..07b169f3 100644 --- a/auto-generated-sdk/docs/PACommentaryRoot.md +++ b/auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md @@ -1,11 +1,12 @@ -# PACommentaryRoot +# QuantIdentifierUniverseObsolete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PACommentary**](PACommentary.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**universe_type** | **str** | | +**identifiers** | **[str]** | | +**source** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/PACommentaryStatusRoot.md b/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md similarity index 60% rename from auto-generated-sdk/docs/PACommentaryStatusRoot.md rename to auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md index 553bffbf..029cc39e 100644 --- a/auto-generated-sdk/docs/PACommentaryStatusRoot.md +++ b/auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md @@ -1,11 +1,12 @@ -# PACommentaryStatusRoot +# QuantScreeningExpressionObsolete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PACommentaryStatus**](PACommentaryStatus.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**expr** | **str** | | +**name** | **str** | | +**date_offset** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md b/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md similarity index 58% rename from auto-generated-sdk/docs/PACommentaryGetStatusRoot.md rename to auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md index 77448c9e..f7bcdddc 100644 --- a/auto-generated-sdk/docs/PACommentaryGetStatusRoot.md +++ b/auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md @@ -1,11 +1,13 @@ -# PACommentaryGetStatusRoot +# QuantScreeningExpressionUniverseObsolete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**PACommentaryGetStatus**](PACommentaryGetStatus.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**universe_expr** | **str** | | +**universe_type** | **str** | | +**security_expr** | **str** | | [optional] +**source** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/PACommentaryParameters.md b/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md similarity index 73% rename from auto-generated-sdk/docs/PACommentaryParameters.md rename to auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md index 57bcb7c1..025fad24 100644 --- a/auto-generated-sdk/docs/PACommentaryParameters.md +++ b/auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md @@ -1,10 +1,11 @@ -# PACommentaryParameters +# QuantUniversalScreenParameterObsolete ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**configurationid** | **str** | Commentary configuration id | [optional] +**reference_name** | **str** | | +**name** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md b/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md new file mode 100644 index 00000000..87227b51 --- /dev/null +++ b/auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md @@ -0,0 +1,12 @@ +# QuantUniversalScreenUniverseObsolete + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**screen** | **str** | | +**source** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/auto-generated-sdk/docs/SPARCalculationsApi.md b/auto-generated-sdk/docs/SPARCalculationsApi.md index c546aa0f..a1a79c1a 100644 --- a/auto-generated-sdk/docs/SPARCalculationsApi.md +++ b/auto-generated-sdk/docs/SPARCalculationsApi.md @@ -86,7 +86,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details @@ -536,7 +536,6 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: startdate="startdate_example", enddate="enddate_example", frequency="frequency_example", - useeachportfolioinception=True, ), currencyisocode="currencyisocode_example", ), @@ -669,7 +668,6 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client: startdate="startdate_example", enddate="enddate_example", frequency="frequency_example", - useeachportfolioinception=True, ), currencyisocode="currencyisocode_example", ), diff --git a/auto-generated-sdk/docs/SPARDateParameters.md b/auto-generated-sdk/docs/SPARDateParameters.md index a3d38ebb..b713beff 100644 --- a/auto-generated-sdk/docs/SPARDateParameters.md +++ b/auto-generated-sdk/docs/SPARDateParameters.md @@ -8,7 +8,6 @@ Name | Type | Description | Notes **startdate** | **str** | Calculation's start date. | **enddate** | **str** | Calculation's end date. | **frequency** | **str** | Calculation's frequency. | -**useeachportfolioinception** | **bool** | Use Each Portfolio Inception | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/auto-generated-sdk/docs/Section.md b/auto-generated-sdk/docs/Section.md deleted file mode 100644 index 84c6e95a..00000000 --- a/auto-generated-sdk/docs/Section.md +++ /dev/null @@ -1,14 +0,0 @@ -# Section - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**metadata** | [**Metadata**](Metadata.md) | | [optional] -**title** | **str** | Commentary title | [optional] -**content** | **str** | Generated commentary content | [optional] -**sub_sections** | [**[Section]**](Section.md) | Generated commentary subsections | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/TemplatedPAComponentsApi.md b/auto-generated-sdk/docs/TemplatedPAComponentsApi.md index 9524b269..e9050ce3 100644 --- a/auto-generated-sdk/docs/TemplatedPAComponentsApi.md +++ b/auto-generated-sdk/docs/TemplatedPAComponentsApi.md @@ -142,7 +142,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details @@ -232,7 +232,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderApi.md b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md deleted file mode 100644 index 6937cd61..00000000 --- a/auto-generated-sdk/docs/VaultAttributionLoaderApi.md +++ /dev/null @@ -1,112 +0,0 @@ - -# fds.analyticsapi.engines.VaultAttributionLoaderApi - -All URIs are relative to *https://api.factset.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**vault_attribution_loader**](VaultAttributionLoaderApi.md#vault_attribution_loader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader - - -# **vault_attribution_loader** -> VaultAttributionLoaderResponseRoot vault_attribution_loader(batch_id) - -Vault - External Attribution Loader - -This endpoint loads Vault External Attributions. - -### Example - -* Basic Authentication (Basic): -* Bearer Authentication (Bearer): -```python -import time -import fds.analyticsapi.engines -from fds.analyticsapi.engines.api import vault_attribution_loader_api -from fds.analyticsapi.engines.model.vault_attribution_loader_response_root import VaultAttributionLoaderResponseRoot -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from pprint import pprint -# Defining the host is optional and defaults to https://api.factset.com -# See configuration.py for a list of all supported configuration parameters. -configuration = fds.analyticsapi.engines.Configuration( - host = "https://api.factset.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: Basic -configuration = fds.analyticsapi.engines.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure Bearer authorization: Bearer -configuration = fds.analyticsapi.engines.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Enter a context with an instance of the API client -with fds.analyticsapi.engines.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = vault_attribution_loader_api.VaultAttributionLoaderApi(api_client) - batch_id = "batchId_example" # str | - file = open('/path/to/file', 'rb') # file_type, none_type | (optional) - - # example passing only required values which don't have defaults set - try: - # Vault - External Attribution Loader - api_response = api_instance.vault_attribution_loader(batch_id) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling VaultAttributionLoaderApi->vault_attribution_loader: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Vault - External Attribution Loader - api_response = api_instance.vault_attribution_loader(batch_id, file=file) - pprint(api_response) - except fds.analyticsapi.engines.ApiException as e: - print("Exception when calling VaultAttributionLoaderApi->vault_attribution_loader: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **batch_id** | **str**| | - **file** | **file_type, none_type**| | [optional] - -### Return type - - - A tuple with response data, HTTP status code and response headers. - - **Response datatype**: [**VaultAttributionLoaderResponseRoot**](VaultAttributionLoaderResponseRoot.md) - -### Authorization - -[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Expected response, returns a status of operation along with errors and warnings if found any. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**400** | Bad Request | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| -**429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| -**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| -**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md deleted file mode 100644 index 7d4e0746..00000000 --- a/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# VaultAttributionLoaderResponse - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**process_id** | **str** | ProcessId. | [optional] -**group_id** | **str** | GroupId. | [optional] -**object_id** | **str** | ObjectId. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md deleted file mode 100644 index 9576a88d..00000000 --- a/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md +++ /dev/null @@ -1,12 +0,0 @@ -# VaultAttributionLoaderResponseRoot - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**VaultAttributionLoaderResponse**](VaultAttributionLoaderResponse.md) | | -**meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/auto-generated-sdk/docs/VaultCalculationsApi.md b/auto-generated-sdk/docs/VaultCalculationsApi.md index 4737ab50..2054fea7 100644 --- a/auto-generated-sdk/docs/VaultCalculationsApi.md +++ b/auto-generated-sdk/docs/VaultCalculationsApi.md @@ -86,7 +86,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: text/plain, application/json, text/json ### HTTP response details diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py index 1fa50663..25483ab0 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py @@ -23,7 +23,6 @@ validate_and_convert_types ) from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.pa_commentary_configuration_summary_root import PACommentaryConfigurationSummaryRoot from fds.analyticsapi.engines.model.vault_configuration_root import VaultConfigurationRoot from fds.analyticsapi.engines.model.vault_configuration_summary_root import VaultConfigurationSummaryRoot @@ -40,126 +39,6 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def __get_pa_commentary_configurations( - self, - path, - **kwargs - ): - """Get PA commentary configurations in a directory # noqa: E501 - - This endpoint returns all PA commentary configurations in a given directory. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_commentary_configurations(path, async_req=True) - >>> result = thread.get() - - Args: - path (str): The directory to get the PA commentary configurations - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - PACommentaryConfigurationSummaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['path'] = \ - path - return self.call_with_http_info(**kwargs) - - self.get_pa_commentary_configurations = _Endpoint( - settings={ - 'response_type': dict({ 200:(PACommentaryConfigurationSummaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/commentary/configurations', - 'operation_id': 'get_pa_commentary_configurations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'path', - ], - 'required': [ - 'path', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'path': - (str,), - }, - 'attribute_map': { - 'path': 'path', - }, - 'location_map': { - 'path': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_commentary_configurations - ) - def __get_vault_configuration_by_id( self, id, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py index c49cefac..542accf9 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py @@ -152,7 +152,9 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py index 66764fad..a3711081 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py @@ -275,7 +275,9 @@ def __delete_linked_pa_templates( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py index 277bae14..44812edb 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py @@ -27,10 +27,6 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.object_root import ObjectRoot from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot -from fds.analyticsapi.engines.model.pa_commentary_get_status_root import PACommentaryGetStatusRoot -from fds.analyticsapi.engines.model.pa_commentary_parameters_root import PACommentaryParametersRoot -from fds.analyticsapi.engines.model.pa_commentary_root import PACommentaryRoot -from fds.analyticsapi.engines.model.pa_commentary_status_root import PACommentaryStatusRoot class PACalculationsApi(object): @@ -157,7 +153,9 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, @@ -165,143 +163,6 @@ def __cancel_calculation_by_id( callable=__cancel_calculation_by_id ) - def __generate_pa_portfolio_commentary( - self, - id, - unit_id, - **kwargs - ): - """Generate PA portfolio commentary by calculation and unit id. # noqa: E501 - - This endpoint can be used to generate the PA portfolio commentary based on a previous successful calculation. Remarks: * The PA component used in the calculation must be an attribution tile. * The \"Variation in Average Weight\" column must be included along with those required as specified on the [OA page](https://my.apps.factset.com/oa/pages/13632#portfolio_commentary) in the component for successful commentary generation; otherwise, the request will result in an error. * PA portfolio commentary generation is not supported for multi-port requests. * The POST calculation must use a single portfolio and a benchmark to generate the commentary. * PA portfolio commentary with sub-period analysis will be returned only when the frequency is set to something other than \"single\" and the report contains more than one sub-period. * Commentary customization is optional. Please include a configuration ID in the request body when customization is desired. If the configuration ID is not specified, the default commentary will be returned. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.generate_pa_portfolio_commentary(id, unit_id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Successful calculation id - unit_id (str): Unit id associated with the successful calculation id - - Keyword Args: - pa_commentary_parameters_root (PACommentaryParametersRoot): Request Parameters. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - (For 201 status - PACommentaryRoot)(For 202 status - PACommentaryGetStatusRoot) - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - kwargs['unit_id'] = \ - unit_id - return self.call_with_http_info(**kwargs) - - self.generate_pa_portfolio_commentary = _Endpoint( - settings={ - 'response_type': dict({ 201:(PACommentaryRoot,), 202:(PACommentaryGetStatusRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary', - 'operation_id': 'generate_pa_portfolio_commentary', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'unit_id', - 'pa_commentary_parameters_root', - ], - 'required': [ - 'id', - 'unit_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'unit_id': - (str,), - 'pa_commentary_parameters_root': - (PACommentaryParametersRoot,), - }, - 'attribute_map': { - 'id': 'id', - 'unit_id': 'unitId', - }, - 'location_map': { - 'id': 'path', - 'unit_id': 'path', - 'pa_commentary_parameters_root': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client, - callable=__generate_pa_portfolio_commentary - ) - def __get_all_calculations( self, **kwargs @@ -787,266 +648,6 @@ def __get_calculation_unit_result_by_id( callable=__get_calculation_unit_result_by_id ) - def __get_pa_portfolio_commentary_result_by_id( - self, - id, - unit_id, - **kwargs - ): - """Get PA Portfolio commentary result by calculation and unit id. # noqa: E501 - - This endpoint retrieves the result of a previously requested portfolio commentary. If the commentary generation is complete, the commentary will be returned in a predefined JSON format. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_portfolio_commentary_result_by_id(id, unit_id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Successful calculation id - unit_id (str): Unit id associated with the successful calculation id - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - PACommentaryRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - kwargs['unit_id'] = \ - unit_id - return self.call_with_http_info(**kwargs) - - self.get_pa_portfolio_commentary_result_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(PACommentaryRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/result', - 'operation_id': 'get_pa_portfolio_commentary_result_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'unit_id', - ], - 'required': [ - 'id', - 'unit_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'unit_id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'unit_id': 'unitId', - }, - 'location_map': { - 'id': 'path', - 'unit_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_portfolio_commentary_result_by_id - ) - - def __get_pa_portfolio_commentary_status_by_id( - self, - id, - unit_id, - **kwargs - ): - """Get PA portfolio commentary status by calculation and unit id. # noqa: E501 - - This endpoint allows you to check the progress of a previously requested PA portfolio commentary. If the commentary generation is complete, the location header will provide the URL for the result. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_pa_portfolio_commentary_status_by_id(id, unit_id, async_req=True) - >>> result = thread.get() - - Args: - id (str): Successful calculation id - unit_id (str): Unit id associated with the successful calculation id - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - (For 200 status - PACommentaryStatusRoot)(For 202 status - PACommentaryGetStatusRoot) - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['id'] = \ - id - kwargs['unit_id'] = \ - unit_id - return self.call_with_http_info(**kwargs) - - self.get_pa_portfolio_commentary_status_by_id = _Endpoint( - settings={ - 'response_type': dict({ 200:(PACommentaryStatusRoot,), 202:(PACommentaryGetStatusRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/pa/v3/calculations/{id}/units/{unitId}/commentary/status', - 'operation_id': 'get_pa_portfolio_commentary_status_by_id', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'unit_id', - ], - 'required': [ - 'id', - 'unit_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'unit_id': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'unit_id': 'unitId', - }, - 'location_map': { - 'id': 'path', - 'unit_id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client, - callable=__get_pa_portfolio_commentary_status_by_id - ) - def __post_and_calculate( self, **kwargs diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py index 901503a3..daa6591a 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py @@ -152,7 +152,9 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, @@ -636,9 +638,9 @@ def __get_calculation_unit_result_by_id( }, headers_map={ 'accept': [ - 'application/pdf', - 'application/vnd.openxmlformats-officedocument.presentationml.presentation', - 'application/json' + 'application/json', + 'application/x-protobuf', + 'application/pdf' ], 'content_type': [], }, @@ -685,7 +687,7 @@ def __post_and_calculate( async_req (bool): execute request asynchronously Returns: - (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) + (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) If the method is called asynchronously, returns the request thread. """ @@ -712,7 +714,7 @@ def __post_and_calculate( self.post_and_calculate = _Endpoint( settings={ - 'response_type': dict({ 200:(CalculationStatusRoot,), 201:(file_type,), 202:(CalculationStatusRoot,), }), + 'response_type': dict({ 202:(CalculationStatusRoot,), 200:(CalculationStatusRoot,), 201:(file_type,), }), 'auth': [ 'Basic', 'Bearer' @@ -763,7 +765,6 @@ def __post_and_calculate( }, headers_map={ 'accept': [ - 'application/json', 'application/pdf', 'application/vnd.openxmlformats-officedocument.presentationml.presentation' ], @@ -817,7 +818,7 @@ def __put_and_calculate( async_req (bool): execute request asynchronously Returns: - (For 200 status - CalculationStatusRoot)(For 201 status - File)(For 202 status - CalculationStatusRoot) + (For 202 status - CalculationStatusRoot)(For 200 status - CalculationStatusRoot)(For 201 status - File) If the method is called asynchronously, returns the request thread. """ @@ -846,7 +847,7 @@ def __put_and_calculate( self.put_and_calculate = _Endpoint( settings={ - 'response_type': dict({ 200:(CalculationStatusRoot,), 201:(file_type,), 202:(CalculationStatusRoot,), }), + 'response_type': dict({ 202:(CalculationStatusRoot,), 200:(CalculationStatusRoot,), 201:(file_type,), }), 'auth': [ 'Basic', 'Bearer' @@ -904,9 +905,7 @@ def __put_and_calculate( }, headers_map={ 'accept': [ - 'application/json', - 'application/pdf', - 'application/vnd.openxmlformats-officedocument.presentationml.presentation' + 'application/pdf' ], 'content_type': [ 'application/json' diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py index 8c5173e7..0cbd1688 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py @@ -153,7 +153,9 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py index bc337c87..779c8477 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py @@ -153,7 +153,9 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py index dd662b19..29853f02 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py @@ -153,7 +153,9 @@ def __create_templated_pa_components( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [ 'application/json' @@ -275,7 +277,9 @@ def __delete_templated_pa_components( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_attribution_loader_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_attribution_loader_api.py deleted file mode 100644 index 6b695e79..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_attribution_loader_api.py +++ /dev/null @@ -1,168 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.api_client import ApiClient, Endpoint as _Endpoint -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse -from fds.analyticsapi.engines.model.vault_attribution_loader_response_root import VaultAttributionLoaderResponseRoot - - -class VaultAttributionLoaderApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def __vault_attribution_loader( - self, - batch_id, - **kwargs - ): - """Vault - External Attribution Loader # noqa: E501 - - This endpoint loads Vault External Attributions. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.vault_attribution_loader(batch_id, async_req=True) - >>> result = thread.get() - - Args: - batch_id (str): - - Keyword Args: - file (file_type, none_type): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is False. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (float/tuple): timeout setting for this request. If one - number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - VaultAttributionLoaderResponseRoot - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', False - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['batch_id'] = \ - batch_id - return self.call_with_http_info(**kwargs) - - self.vault_attribution_loader = _Endpoint( - settings={ - 'response_type': dict({ 200:(VaultAttributionLoaderResponseRoot,), }), - 'auth': [ - 'Basic', - 'Bearer' - ], - 'endpoint_path': '/analytics/engines/vault/v3/load/{batchId}', - 'operation_id': 'vault_attribution_loader', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'batch_id', - 'file', - ], - 'required': [ - 'batch_id', - ], - 'nullable': [ - 'file', - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'batch_id': - (str,), - 'file': - (file_type, none_type,), - }, - 'attribute_map': { - 'batch_id': 'batchId', - 'file': 'file', - }, - 'location_map': { - 'batch_id': 'path', - 'file': 'form', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'multipart/form-data' - ] - }, - api_client=api_client, - callable=__vault_attribution_loader - ) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py index 13930c14..25863675 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py @@ -153,7 +153,9 @@ def __cancel_calculation_by_id( }, headers_map={ 'accept': [ - 'application/json' + 'text/plain', + 'application/json', + 'text/json' ], 'content_type': [], }, diff --git a/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py index 40498039..fb697d8b 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py @@ -43,4 +43,3 @@ from fds.analyticsapi.engines.api.templated_pa_components_api import TemplatedPAComponentsApi from fds.analyticsapi.engines.api.unlinked_pa_templates_api import UnlinkedPATemplatesApi from fds.analyticsapi.engines.api.vault_calculations_api import VaultCalculationsApi -from fds.analyticsapi.engines.api.vault_attribution_loader_api import VaultAttributionLoaderApi diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_status_meta.py b/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_status_meta.py index 27f400f0..d4eae03b 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_status_meta.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_status_meta.py @@ -136,7 +136,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - units ({str: (CalculationUnitStatusMeta,)}): List of calculation units in batch.. [optional] # noqa: E501 + units ({str: (CalculationUnitStatusMeta,)}): Meta of calculation units in batch.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fi_convertible_settings.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fi_convertible_settings.py deleted file mode 100644 index 9b2bf8b9..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fi_convertible_settings.py +++ /dev/null @@ -1,187 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class FIConvertibleSettings(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('volatility_cap_method',): { - 'NOCAP': "noCap", - 'SPECIFIEDRATE': "specifiedRate", - 'MULTIPLIER': "multiplier", - }, - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'equity_price': (float,), # noqa: E501 - 'equity_index_volatility': (float,), # noqa: E501 - 'equity_dividend_yield': (float,), # noqa: E501 - 'volatility_cap_method': (str,), # noqa: E501 - 'volatility_cap_method_value': (float,), # noqa: E501 - 'equity_exchange_rate': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'equity_price': 'equityPrice', # noqa: E501 - 'equity_index_volatility': 'equityIndexVolatility', # noqa: E501 - 'equity_dividend_yield': 'equityDividendYield', # noqa: E501 - 'volatility_cap_method': 'volatilityCapMethod', # noqa: E501 - 'volatility_cap_method_value': 'volatilityCapMethodValue', # noqa: E501 - 'equity_exchange_rate': 'equityExchangeRate', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """FIConvertibleSettings - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - equity_price (float): Equity Price. [optional] # noqa: E501 - equity_index_volatility (float): Equity Index Volatility. [optional] # noqa: E501 - equity_dividend_yield (float): Equity Dividend Yield. [optional] # noqa: E501 - volatility_cap_method (str): Volatility CapMethod. [optional] # noqa: E501 - volatility_cap_method_value (float): Volatility CapMethod Value - (Required only when volatilityCapMethod is specifiedRate or multiplier). [optional] # noqa: E501 - equity_exchange_rate (float): Equity Exchange Rate. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/fi_security.py b/auto-generated-sdk/fds/analyticsapi/engines/model/fi_security.py index c43cac3e..6a5d29a4 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/fi_security.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/fi_security.py @@ -30,7 +30,6 @@ def lazy_import(): from fds.analyticsapi.engines.model.fi_attribution_for_securities import FIAttributionForSecurities from fds.analyticsapi.engines.model.fi_bank_loans import FIBankLoans - from fds.analyticsapi.engines.model.fi_convertible_settings import FIConvertibleSettings from fds.analyticsapi.engines.model.fi_loss import FILoss from fds.analyticsapi.engines.model.fi_municipal_bonds import FIMunicipalBonds from fds.analyticsapi.engines.model.fi_prepay import FIPrepay @@ -38,7 +37,6 @@ def lazy_import(): from fds.analyticsapi.engines.model.fi_structured_products_for_securities import FIStructuredProductsForSecurities globals()['FIAttributionForSecurities'] = FIAttributionForSecurities globals()['FIBankLoans'] = FIBankLoans - globals()['FIConvertibleSettings'] = FIConvertibleSettings globals()['FILoss'] = FILoss globals()['FIMunicipalBonds'] = FIMunicipalBonds globals()['FIPrepay'] = FIPrepay @@ -115,7 +113,6 @@ def openapi_types(): 'matrix_multiplier': (float,), # noqa: E501 'structured_products': (FIStructuredProductsForSecurities,), # noqa: E501 'attribution': (FIAttributionForSecurities,), # noqa: E501 - 'convertible': (FIConvertibleSettings,), # noqa: E501 'calc_from_method': (str,), # noqa: E501 'face': (float,), # noqa: E501 'face_type': (str,), # noqa: E501 @@ -141,7 +138,6 @@ def discriminator(): 'matrix_multiplier': 'matrixMultiplier', # noqa: E501 'structured_products': 'structuredProducts', # noqa: E501 'attribution': 'attribution', # noqa: E501 - 'convertible': 'convertible', # noqa: E501 'calc_from_method': 'calcFromMethod', # noqa: E501 'face': 'face', # noqa: E501 'face_type': 'faceType', # noqa: E501 @@ -209,7 +205,6 @@ def __init__(self, calc_from_value, symbol, *args, **kwargs): # noqa: E501 matrix_multiplier (float): Matrix Multiplier. [optional] # noqa: E501 structured_products (FIStructuredProductsForSecurities): [optional] # noqa: E501 attribution (FIAttributionForSecurities): [optional] # noqa: E501 - convertible (FIConvertibleSettings): [optional] # noqa: E501 calc_from_method (str): Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix. [optional] # noqa: E501 face (float): Face. [optional] if omitted the server will use the default value of 1 # noqa: E501 face_type (str): Face type. [optional] if omitted the server will use the default value of "Current" # noqa: E501 diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/metadata.py b/auto-generated-sdk/fds/analyticsapi/engines/model/metadata.py deleted file mode 100644 index 70fdc030..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/metadata.py +++ /dev/null @@ -1,187 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_commentary_date import PACommentaryDate - globals()['PACommentaryDate'] = PACommentaryDate - - -class Metadata(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'tile_name': (str,), # noqa: E501 - 'portfolio_description': (str,), # noqa: E501 - 'benchmark_description': (str,), # noqa: E501 - 'start_date': (PACommentaryDate,), # noqa: E501 - 'end_date': (PACommentaryDate,), # noqa: E501 - 'frequency': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'tile_name': 'tileName', # noqa: E501 - 'portfolio_description': 'portfolioDescription', # noqa: E501 - 'benchmark_description': 'benchmarkDescription', # noqa: E501 - 'start_date': 'startDate', # noqa: E501 - 'end_date': 'endDate', # noqa: E501 - 'frequency': 'frequency', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Metadata - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - tile_name (str): PA Tile name associated with the component. [optional] # noqa: E501 - portfolio_description (str): Portfolio name used in generating commentary. [optional] # noqa: E501 - benchmark_description (str): Benchmark name used in generating commentary. [optional] # noqa: E501 - start_date (PACommentaryDate): [optional] # noqa: E501 - end_date (PACommentaryDate): [optional] # noqa: E501 - frequency (str): Date frequency. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_date.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_date.py deleted file mode 100644 index afc1eeff..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_date.py +++ /dev/null @@ -1,170 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PACommentaryDate(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'yyyymmdd': (int,), # noqa: E501 - 'relative': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'yyyymmdd': 'yyyymmdd', # noqa: E501 - 'relative': 'relative', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACommentaryDate - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - yyyymmdd (int): Date can be either absolute (YYYYMMDD) or relative, but only one format should be set at a time.. [optional] # noqa: E501 - relative (str): Date can be either relative or absolute (YYYYMMDD), but only one format should be set at a time.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status.py deleted file mode 100644 index f2045afc..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status.py +++ /dev/null @@ -1,177 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PACommentaryGetStatus(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('status',): { - 'EXECUTING': "Executing", - 'SUCCESS': "Success", - }, - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'calculationid': (str,), # noqa: E501 - 'unitid': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'calculationid': 'calculationid', # noqa: E501 - 'unitid': 'unitid', # noqa: E501 - 'status': 'status', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACommentaryGetStatus - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - calculationid (str): Calculation id.. [optional] # noqa: E501 - unitid (str): Calculation unit id.. [optional] # noqa: E501 - status (str): The status of commentary generation.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status.py deleted file mode 100644 index 52358e2a..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status.py +++ /dev/null @@ -1,180 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class PACommentaryStatus(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - ('status',): { - 'EXECUTING': "Executing", - 'SUCCESS': "Success", - }, - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'result': (str,), # noqa: E501 - 'calculationid': (str,), # noqa: E501 - 'unitid': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'result': 'result', # noqa: E501 - 'calculationid': 'calculationid', # noqa: E501 - 'unitid': 'unitid', # noqa: E501 - 'status': 'status', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACommentaryStatus - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - result (str): The result url of the generated commentary.. [optional] # noqa: E501 - calculationid (str): Calculation id.. [optional] # noqa: E501 - unitid (str): Calculation unit id.. [optional] # noqa: E501 - status (str): The status of commentary generation.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status_root.py deleted file mode 100644 index 4b9cece9..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_status_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.pa_commentary_status import PACommentaryStatus - globals()['PACommentaryStatus'] = PACommentaryStatus - - -class PACommentaryStatusRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (PACommentaryStatus,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """PACommentaryStatusRoot - a model defined in OpenAPI - - Args: - data (PACommentaryStatus): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_date_list_obsolete.py similarity index 87% rename from auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/quant_date_list_obsolete.py index 38d79e02..616f7eed 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_date_list_obsolete.py @@ -27,12 +27,8 @@ validate_get_composed_info, ) -def lazy_import(): - from fds.analyticsapi.engines.model.section import Section - globals()['Section'] = Section - -class PACommentary(ModelNormal): +class QuantDateListObsolete(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -76,11 +72,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'commentary_id': (str,), # noqa: E501 - 'sections': ([Section],), # noqa: E501 - 'disclaimer': (str,), # noqa: E501 + 'frequency': (str,), # noqa: E501 + 'calendar': (str,), # noqa: E501 + 'dates': ([str],), # noqa: E501 + 'override_universal_screen_calendar': (bool,), # noqa: E501 } @cached_property @@ -89,9 +85,10 @@ def discriminator(): attribute_map = { - 'commentary_id': 'commentaryId', # noqa: E501 - 'sections': 'sections', # noqa: E501 - 'disclaimer': 'disclaimer', # noqa: E501 + 'frequency': 'frequency', # noqa: E501 + 'calendar': 'calendar', # noqa: E501 + 'dates': 'dates', # noqa: E501 + 'override_universal_screen_calendar': 'overrideUniversalScreenCalendar', # noqa: E501 } _composed_schemas = {} @@ -106,8 +103,12 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACommentary - a model defined in OpenAPI + def __init__(self, frequency, calendar, *args, **kwargs): # noqa: E501 + """QuantDateListObsolete - a model defined in OpenAPI + + Args: + frequency (str): + calendar (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -140,9 +141,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - commentary_id (str): Generated commentary Id. [optional] # noqa: E501 - sections ([Section]): Commentary sections. [optional] # noqa: E501 - disclaimer (str): Disclaimer. [optional] # noqa: E501 + dates ([str]): [optional] # noqa: E501 + override_universal_screen_calendar (bool): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -168,6 +168,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.frequency = frequency + self.calendar = calendar for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fds_date_obsolete.py similarity index 85% rename from auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status_root.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/quant_fds_date_obsolete.py index b60b6d03..e74b9022 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_get_status_root.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fds_date_obsolete.py @@ -27,12 +27,8 @@ validate_get_composed_info, ) -def lazy_import(): - from fds.analyticsapi.engines.model.pa_commentary_get_status import PACommentaryGetStatus - globals()['PACommentaryGetStatus'] = PACommentaryGetStatus - -class PACommentaryGetStatusRoot(ModelNormal): +class QuantFdsDateObsolete(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -76,10 +72,12 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'data': (PACommentaryGetStatus,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + 'frequency': (str,), # noqa: E501 + 'calendar': (str,), # noqa: E501 + 'override_universal_screen_calendar': (bool,), # noqa: E501 } @cached_property @@ -88,8 +86,11 @@ def discriminator(): attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 + 'start_date': 'startDate', # noqa: E501 + 'end_date': 'endDate', # noqa: E501 + 'frequency': 'frequency', # noqa: E501 + 'calendar': 'calendar', # noqa: E501 + 'override_universal_screen_calendar': 'overrideUniversalScreenCalendar', # noqa: E501 } _composed_schemas = {} @@ -104,11 +105,14 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """PACommentaryGetStatusRoot - a model defined in OpenAPI + def __init__(self, start_date, end_date, frequency, calendar, *args, **kwargs): # noqa: E501 + """QuantFdsDateObsolete - a model defined in OpenAPI Args: - data (PACommentaryGetStatus): + start_date (str): + end_date (str): + frequency (str): + calendar (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -141,7 +145,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + override_universal_screen_calendar (bool): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -167,7 +171,10 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.data = data + self.start_date = start_date + self.end_date = end_date + self.frequency = frequency + self.calendar = calendar for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py similarity index 88% rename from auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters_root.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py index 41317920..f3980ea9 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters_root.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_fql_expression_obsolete.py @@ -27,12 +27,8 @@ validate_get_composed_info, ) -def lazy_import(): - from fds.analyticsapi.engines.model.pa_commentary_parameters import PACommentaryParameters - globals()['PACommentaryParameters'] = PACommentaryParameters - -class PACommentaryParametersRoot(ModelNormal): +class QuantFqlExpressionObsolete(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -76,10 +72,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'data': (PACommentaryParameters,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'expr': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'date_offset': (str,), # noqa: E501 + 'is_array_return_type': (bool,), # noqa: E501 } @cached_property @@ -88,8 +85,10 @@ def discriminator(): attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 + 'expr': 'expr', # noqa: E501 + 'name': 'name', # noqa: E501 + 'date_offset': 'dateOffset', # noqa: E501 + 'is_array_return_type': 'isArrayReturnType', # noqa: E501 } _composed_schemas = {} @@ -104,11 +103,12 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """PACommentaryParametersRoot - a model defined in OpenAPI + def __init__(self, expr, name, *args, **kwargs): # noqa: E501 + """QuantFqlExpressionObsolete - a model defined in OpenAPI Args: - data (PACommentaryParameters): + expr (str): + name (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -141,7 +141,8 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + date_offset (str): [optional] # noqa: E501 + is_array_return_type (bool): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -167,7 +168,8 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.data = data + self.expr = expr + self.name = name for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py similarity index 85% rename from auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py index 720de8ac..190e45ca 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary_root.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_identifier_universe_obsolete.py @@ -27,12 +27,8 @@ validate_get_composed_info, ) -def lazy_import(): - from fds.analyticsapi.engines.model.pa_commentary_configuration_summary import PACommentaryConfigurationSummary - globals()['PACommentaryConfigurationSummary'] = PACommentaryConfigurationSummary - -class PACommentaryConfigurationSummaryRoot(ModelNormal): +class QuantIdentifierUniverseObsolete(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,6 +53,15 @@ class PACommentaryConfigurationSummaryRoot(ModelNormal): """ allowed_values = { + ('universe_type',): { + 'EQUITY': "Equity", + 'DEBT': "Debt", + }, + ('source',): { + 'SCREENINGEXPRESSIONUNIVERSE': "ScreeningExpressionUniverse", + 'UNIVERSALSCREENUNIVERSE': "UniversalScreenUniverse", + 'IDENTIFIERUNIVERSE': "IdentifierUniverse", + }, } validations = { @@ -76,10 +81,10 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'data': ({str: (PACommentaryConfigurationSummary,)},), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'universe_type': (str,), # noqa: E501 + 'identifiers': ([str],), # noqa: E501 + 'source': (str,), # noqa: E501 } @cached_property @@ -88,8 +93,9 @@ def discriminator(): attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 + 'universe_type': 'universeType', # noqa: E501 + 'identifiers': 'identifiers', # noqa: E501 + 'source': 'source', # noqa: E501 } _composed_schemas = {} @@ -104,11 +110,12 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """PACommentaryConfigurationSummaryRoot - a model defined in OpenAPI + def __init__(self, universe_type, identifiers, *args, **kwargs): # noqa: E501 + """QuantIdentifierUniverseObsolete - a model defined in OpenAPI Args: - data ({str: (PACommentaryConfigurationSummary,)}): + universe_type (str): + identifiers ([str]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -141,7 +148,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + source (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -167,7 +174,8 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.data = data + self.universe_type = universe_type + self.identifiers = identifiers for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py similarity index 90% rename from auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py index 04a10ff2..8fa16f87 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_parameters.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_obsolete.py @@ -28,7 +28,7 @@ ) -class PACommentaryParameters(ModelNormal): +class QuantScreeningExpressionObsolete(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -73,7 +73,9 @@ def openapi_types(): and the value is attribute type. """ return { - 'configurationid': (str,), # noqa: E501 + 'expr': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'date_offset': (str,), # noqa: E501 } @cached_property @@ -82,7 +84,9 @@ def discriminator(): attribute_map = { - 'configurationid': 'configurationid', # noqa: E501 + 'expr': 'expr', # noqa: E501 + 'name': 'name', # noqa: E501 + 'date_offset': 'dateOffset', # noqa: E501 } _composed_schemas = {} @@ -97,8 +101,12 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACommentaryParameters - a model defined in OpenAPI + def __init__(self, expr, name, *args, **kwargs): # noqa: E501 + """QuantScreeningExpressionObsolete - a model defined in OpenAPI + + Args: + expr (str): + name (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -131,7 +139,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - configurationid (str): Commentary configuration id. [optional] # noqa: E501 + date_offset (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -157,6 +165,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.expr = expr + self.name = name for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py new file mode 100644 index 00000000..19848f8f --- /dev/null +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_screening_expression_universe_obsolete.py @@ -0,0 +1,189 @@ +""" + Engines API + + Allow clients to fetch Analytics through APIs. # noqa: E501 + + The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] + Contact: api@factset.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fds.analyticsapi.engines.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class QuantScreeningExpressionUniverseObsolete(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('universe_type',): { + 'EQUITY': "Equity", + 'DEBT': "Debt", + }, + ('source',): { + 'SCREENINGEXPRESSIONUNIVERSE': "ScreeningExpressionUniverse", + 'UNIVERSALSCREENUNIVERSE': "UniversalScreenUniverse", + 'IDENTIFIERUNIVERSE': "IdentifierUniverse", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'universe_expr': (str,), # noqa: E501 + 'universe_type': (str,), # noqa: E501 + 'security_expr': (str,), # noqa: E501 + 'source': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'universe_expr': 'universeExpr', # noqa: E501 + 'universe_type': 'universeType', # noqa: E501 + 'security_expr': 'securityExpr', # noqa: E501 + 'source': 'source', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, universe_expr, universe_type, *args, **kwargs): # noqa: E501 + """QuantScreeningExpressionUniverseObsolete - a model defined in OpenAPI + + Args: + universe_expr (str): + universe_type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + security_expr (str): [optional] # noqa: E501 + source (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.universe_expr = universe_expr + self.universe_type = universe_type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py similarity index 93% rename from auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py index 335b2794..6d3ecdd4 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_configuration_summary.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_parameter_obsolete.py @@ -28,7 +28,7 @@ ) -class PACommentaryConfigurationSummary(ModelNormal): +class QuantUniversalScreenParameterObsolete(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -73,8 +73,8 @@ def openapi_types(): and the value is attribute type. """ return { + 'reference_name': (str,), # noqa: E501 'name': (str,), # noqa: E501 - 'directory': (str,), # noqa: E501 } @cached_property @@ -83,8 +83,8 @@ def discriminator(): attribute_map = { + 'reference_name': 'referenceName', # noqa: E501 'name': 'name', # noqa: E501 - 'directory': 'directory', # noqa: E501 } _composed_schemas = {} @@ -99,8 +99,12 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """PACommentaryConfigurationSummary - a model defined in OpenAPI + def __init__(self, reference_name, name, *args, **kwargs): # noqa: E501 + """QuantUniversalScreenParameterObsolete - a model defined in OpenAPI + + Args: + reference_name (str): + name (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -133,8 +137,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - name (str): PA commentary configuration name. [optional] # noqa: E501 - directory (str): PA Commentary configuration directory. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -160,6 +162,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.reference_name = reference_name + self.name = name for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py similarity index 89% rename from auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_root.py rename to auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py index 4cbb2fe7..732831bd 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/pa_commentary_root.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_universal_screen_universe_obsolete.py @@ -27,12 +27,8 @@ validate_get_composed_info, ) -def lazy_import(): - from fds.analyticsapi.engines.model.pa_commentary import PACommentary - globals()['PACommentary'] = PACommentary - -class PACommentaryRoot(ModelNormal): +class QuantUniversalScreenUniverseObsolete(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,6 +53,11 @@ class PACommentaryRoot(ModelNormal): """ allowed_values = { + ('source',): { + 'SCREENINGEXPRESSIONUNIVERSE': "ScreeningExpressionUniverse", + 'UNIVERSALSCREENUNIVERSE': "UniversalScreenUniverse", + 'IDENTIFIERUNIVERSE': "IdentifierUniverse", + }, } validations = { @@ -76,10 +77,9 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'data': (PACommentary,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'screen': (str,), # noqa: E501 + 'source': (str,), # noqa: E501 } @cached_property @@ -88,8 +88,8 @@ def discriminator(): attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 + 'screen': 'screen', # noqa: E501 + 'source': 'source', # noqa: E501 } _composed_schemas = {} @@ -104,11 +104,11 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """PACommentaryRoot - a model defined in OpenAPI + def __init__(self, screen, *args, **kwargs): # noqa: E501 + """QuantUniversalScreenUniverseObsolete - a model defined in OpenAPI Args: - data (PACommentary): + screen (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -141,7 +141,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + source (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -167,7 +167,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.data = data + self.screen = screen for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/section.py b/auto-generated-sdk/fds/analyticsapi/engines/model/section.py deleted file mode 100644 index 9c60b1ff..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/section.py +++ /dev/null @@ -1,181 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.metadata import Metadata - globals()['Metadata'] = Metadata - - -class Section(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'metadata': (Metadata,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'content': (str,), # noqa: E501 - 'sub_sections': ([Section],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'metadata': 'metadata', # noqa: E501 - 'title': 'title', # noqa: E501 - 'content': 'content', # noqa: E501 - 'sub_sections': 'subSections', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """Section - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - metadata (Metadata): [optional] # noqa: E501 - title (str): Commentary title. [optional] # noqa: E501 - content (str): Generated commentary content. [optional] # noqa: E501 - sub_sections ([Section]): Generated commentary subsections. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/spar_date_parameters.py b/auto-generated-sdk/fds/analyticsapi/engines/model/spar_date_parameters.py index 4478b109..aa48608a 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/spar_date_parameters.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/model/spar_date_parameters.py @@ -76,7 +76,6 @@ def openapi_types(): 'startdate': (str,), # noqa: E501 'enddate': (str,), # noqa: E501 'frequency': (str,), # noqa: E501 - 'useeachportfolioinception': (bool,), # noqa: E501 } @cached_property @@ -88,7 +87,6 @@ def discriminator(): 'startdate': 'startdate', # noqa: E501 'enddate': 'enddate', # noqa: E501 'frequency': 'frequency', # noqa: E501 - 'useeachportfolioinception': 'useeachportfolioinception', # noqa: E501 } _composed_schemas = {} @@ -142,7 +140,6 @@ def __init__(self, startdate, enddate, frequency, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - useeachportfolioinception (bool): Use Each Portfolio Inception. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response.py b/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response.py deleted file mode 100644 index c9c675a1..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response.py +++ /dev/null @@ -1,173 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class VaultAttributionLoaderResponse(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'process_id': (str,), # noqa: E501 - 'group_id': (str,), # noqa: E501 - 'object_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'process_id': 'processId', # noqa: E501 - 'group_id': 'groupId', # noqa: E501 - 'object_id': 'objectId', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """VaultAttributionLoaderResponse - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - process_id (str): ProcessId.. [optional] # noqa: E501 - group_id (str): GroupId.. [optional] # noqa: E501 - object_id (str): ObjectId.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py b/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py deleted file mode 100644 index 000a7dfe..00000000 --- a/auto-generated-sdk/fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - Engines API - - Allow clients to fetch Analytics through APIs. # noqa: E501 - - The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] - Contact: api@factset.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from fds.analyticsapi.engines.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from fds.analyticsapi.engines.model.vault_attribution_loader_response import VaultAttributionLoaderResponse - globals()['VaultAttributionLoaderResponse'] = VaultAttributionLoaderResponse - - -class VaultAttributionLoaderResponseRoot(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'data': (VaultAttributionLoaderResponse,), # noqa: E501 - 'meta': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'data': 'data', # noqa: E501 - 'meta': 'meta', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, data, *args, **kwargs): # noqa: E501 - """VaultAttributionLoaderResponseRoot - a model defined in OpenAPI - - Args: - data (VaultAttributionLoaderResponse): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - meta (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.data = data - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py index 6fa013ec..b2d0861a 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/models/__init__.py @@ -67,7 +67,6 @@ from fds.analyticsapi.engines.model.fi_calculation_parameters import FICalculationParameters from fds.analyticsapi.engines.model.fi_calculation_parameters_root import FICalculationParametersRoot from fds.analyticsapi.engines.model.fi_cashflows import FICashflows -from fds.analyticsapi.engines.model.fi_convertible_settings import FIConvertibleSettings from fds.analyticsapi.engines.model.fi_discount_curve_info import FIDiscountCurveInfo from fds.analyticsapi.engines.model.fi_discount_curve_info_root import FIDiscountCurveInfoRoot from fds.analyticsapi.engines.model.fi_job_settings import FIJobSettings @@ -104,7 +103,6 @@ from fds.analyticsapi.engines.model.linked_pa_template_summary_root import LinkedPATemplateSummaryRoot from fds.analyticsapi.engines.model.linked_pa_template_update_parameters import LinkedPATemplateUpdateParameters from fds.analyticsapi.engines.model.linked_pa_template_update_parameters_root import LinkedPATemplateUpdateParametersRoot -from fds.analyticsapi.engines.model.metadata import Metadata from fds.analyticsapi.engines.model.npo_optimization_parameters import NPOOptimizationParameters from fds.analyticsapi.engines.model.npo_optimization_parameters_root import NPOOptimizationParametersRoot from fds.analyticsapi.engines.model.npo_optimizer_strategy import NPOOptimizerStrategy @@ -123,17 +121,6 @@ from fds.analyticsapi.engines.model.pa_calculation_parameters import PACalculationParameters from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot from fds.analyticsapi.engines.model.pa_calculation_pricing_source import PACalculationPricingSource -from fds.analyticsapi.engines.model.pa_commentary import PACommentary -from fds.analyticsapi.engines.model.pa_commentary_configuration_summary import PACommentaryConfigurationSummary -from fds.analyticsapi.engines.model.pa_commentary_configuration_summary_root import PACommentaryConfigurationSummaryRoot -from fds.analyticsapi.engines.model.pa_commentary_date import PACommentaryDate -from fds.analyticsapi.engines.model.pa_commentary_get_status import PACommentaryGetStatus -from fds.analyticsapi.engines.model.pa_commentary_get_status_root import PACommentaryGetStatusRoot -from fds.analyticsapi.engines.model.pa_commentary_parameters import PACommentaryParameters -from fds.analyticsapi.engines.model.pa_commentary_parameters_root import PACommentaryParametersRoot -from fds.analyticsapi.engines.model.pa_commentary_root import PACommentaryRoot -from fds.analyticsapi.engines.model.pa_commentary_status import PACommentaryStatus -from fds.analyticsapi.engines.model.pa_commentary_status_root import PACommentaryStatusRoot from fds.analyticsapi.engines.model.pa_component import PAComponent from fds.analyticsapi.engines.model.pa_component_data import PAComponentData from fds.analyticsapi.engines.model.pa_component_root import PAComponentRoot @@ -154,14 +141,22 @@ from fds.analyticsapi.engines.model.quant_calculation_parameters_root import QuantCalculationParametersRoot from fds.analyticsapi.engines.model.quant_date import QuantDate from fds.analyticsapi.engines.model.quant_date_list import QuantDateList +from fds.analyticsapi.engines.model.quant_date_list_obsolete import QuantDateListObsolete from fds.analyticsapi.engines.model.quant_fds_date import QuantFdsDate +from fds.analyticsapi.engines.model.quant_fds_date_obsolete import QuantFdsDateObsolete from fds.analyticsapi.engines.model.quant_formula import QuantFormula from fds.analyticsapi.engines.model.quant_fql_expression import QuantFqlExpression +from fds.analyticsapi.engines.model.quant_fql_expression_obsolete import QuantFqlExpressionObsolete from fds.analyticsapi.engines.model.quant_identifier_universe import QuantIdentifierUniverse +from fds.analyticsapi.engines.model.quant_identifier_universe_obsolete import QuantIdentifierUniverseObsolete from fds.analyticsapi.engines.model.quant_screening_expression import QuantScreeningExpression +from fds.analyticsapi.engines.model.quant_screening_expression_obsolete import QuantScreeningExpressionObsolete from fds.analyticsapi.engines.model.quant_screening_expression_universe import QuantScreeningExpressionUniverse +from fds.analyticsapi.engines.model.quant_screening_expression_universe_obsolete import QuantScreeningExpressionUniverseObsolete from fds.analyticsapi.engines.model.quant_universal_screen_parameter import QuantUniversalScreenParameter +from fds.analyticsapi.engines.model.quant_universal_screen_parameter_obsolete import QuantUniversalScreenParameterObsolete from fds.analyticsapi.engines.model.quant_universal_screen_universe import QuantUniversalScreenUniverse +from fds.analyticsapi.engines.model.quant_universal_screen_universe_obsolete import QuantUniversalScreenUniverseObsolete from fds.analyticsapi.engines.model.quant_universe import QuantUniverse from fds.analyticsapi.engines.model.return_type import ReturnType from fds.analyticsapi.engines.model.spar_accounts import SPARAccounts @@ -174,7 +169,6 @@ from fds.analyticsapi.engines.model.spar_component_root import SPARComponentRoot from fds.analyticsapi.engines.model.spar_date_parameters import SPARDateParameters from fds.analyticsapi.engines.model.spar_identifier import SPARIdentifier -from fds.analyticsapi.engines.model.section import Section from fds.analyticsapi.engines.model.template_content_types import TemplateContentTypes from fds.analyticsapi.engines.model.templated_pa_component import TemplatedPAComponent from fds.analyticsapi.engines.model.templated_pa_component_parameters import TemplatedPAComponentParameters @@ -202,8 +196,6 @@ from fds.analyticsapi.engines.model.unlinked_pa_template_summary_root import UnlinkedPATemplateSummaryRoot from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters import UnlinkedPATemplateUpdateParameters from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters_root import UnlinkedPATemplateUpdateParametersRoot -from fds.analyticsapi.engines.model.vault_attribution_loader_response import VaultAttributionLoaderResponse -from fds.analyticsapi.engines.model.vault_attribution_loader_response_root import VaultAttributionLoaderResponseRoot from fds.analyticsapi.engines.model.vault_calculation_parameters import VaultCalculationParameters from fds.analyticsapi.engines.model.vault_calculation_parameters_root import VaultCalculationParametersRoot from fds.analyticsapi.engines.model.vault_component import VaultComponent From 5a59d57e79dc70179d172060b5ee4de7f00d0ce5 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 13:00:47 +0000 Subject: [PATCH 05/10] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.1.0 --- .../fds/analyticsapi/engines/api/accounts_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/afi_optimizer_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/axp_optimizer_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/benchmarks_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/bpm_optimizer_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/column_statistics_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/columns_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/components_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/configurations_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/currencies_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/dates_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/discount_curves_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/documents_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/fi_calculations_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/fiab_calculations_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/fpo_optimizer_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/frequencies_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/groups_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/linked_pa_templates_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/npo_optimizer_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/pa_calculations_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/pricing_sources_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/pub_calculations_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/quant_calculations_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/spar_calculations_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/strategy_documents_api.py | 6 ++++++ .../analyticsapi/engines/api/templated_pa_components_api.py | 6 ++++++ .../analyticsapi/engines/api/unlinked_pa_templates_api.py | 6 ++++++ .../fds/analyticsapi/engines/api/vault_calculations_api.py | 6 ++++++ 29 files changed, 174 insertions(+) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py index cd32a4a5..7e2700f7 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py @@ -26,6 +26,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.spar_accounts_root import SPARAccountsRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class AccountsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/afi_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/afi_optimizer_api.py index 7b42e071..bf2033f3 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/afi_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/afi_optimizer_api.py @@ -27,6 +27,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.object_root import ObjectRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class AFIOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/axp_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/axp_optimizer_api.py index f2e91dfe..998b3e53 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/axp_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/axp_optimizer_api.py @@ -27,6 +27,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.object_root import ObjectRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class AXPOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/benchmarks_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/benchmarks_api.py index fad17319..32534fc3 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/benchmarks_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/benchmarks_api.py @@ -25,6 +25,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.spar_benchmark_root import SPARBenchmarkRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class BenchmarksApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/bpm_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/bpm_optimizer_api.py index 01375c40..1b68c73b 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/bpm_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/bpm_optimizer_api.py @@ -27,6 +27,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.object_root import ObjectRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class BPMOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py index e5721526..a55cc678 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py @@ -24,6 +24,12 @@ ) from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class ColumnStatisticsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py index 05991551..820a7918 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py @@ -26,6 +26,12 @@ from fds.analyticsapi.engines.model.column_root import ColumnRoot from fds.analyticsapi.engines.model.column_summary_root import ColumnSummaryRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class ColumnsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py index 5f3c3984..7751cb86 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py @@ -28,6 +28,12 @@ from fds.analyticsapi.engines.model.spar_component_root import SPARComponentRoot from fds.analyticsapi.engines.model.vault_component_root import VaultComponentRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class ComponentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py index 25483ab0..450f0a26 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py @@ -26,6 +26,12 @@ from fds.analyticsapi.engines.model.vault_configuration_root import VaultConfigurationRoot from fds.analyticsapi.engines.model.vault_configuration_summary_root import VaultConfigurationSummaryRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class ConfigurationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/currencies_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/currencies_api.py index e60cb87e..2253d5f4 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/currencies_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/currencies_api.py @@ -24,6 +24,12 @@ ) from fds.analyticsapi.engines.model.currency_root import CurrencyRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class CurrenciesApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py index b73c6dd8..827ead5e 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py @@ -25,6 +25,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.date_parameters_summary_root import DateParametersSummaryRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class DatesApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/discount_curves_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/discount_curves_api.py index 68474629..a87110b1 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/discount_curves_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/discount_curves_api.py @@ -25,6 +25,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.fi_discount_curve_info_root import FIDiscountCurveInfoRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class DiscountCurvesApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py index 89e90dd8..eb1c602a 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py @@ -25,6 +25,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class DocumentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py index 542accf9..9e6e8827 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py @@ -27,6 +27,12 @@ from fds.analyticsapi.engines.model.fi_calculation_parameters_root import FICalculationParametersRoot from fds.analyticsapi.engines.model.object_root import ObjectRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class FICalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fiab_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fiab_calculations_api.py index b54cc941..6cb63dc9 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fiab_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fiab_calculations_api.py @@ -26,6 +26,12 @@ from fds.analyticsapi.engines.model.fiab_calculation_status import FIABCalculationStatus from fds.analyticsapi.engines.model.fiab_calculation_status_summary import FIABCalculationStatusSummary +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class FIABCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py index 1ab4b386..c1d77064 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py @@ -27,6 +27,12 @@ from fds.analyticsapi.engines.model.fpo_optimization_parameters_root import FPOOptimizationParametersRoot from fds.analyticsapi.engines.model.object_root import ObjectRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class FPOOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py index e8047224..107297c1 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py @@ -24,6 +24,12 @@ ) from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class FrequenciesApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py index 3b201e16..bc6e9fda 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py @@ -25,6 +25,12 @@ from fds.analyticsapi.engines.model.frequency_root import FrequencyRoot from fds.analyticsapi.engines.model.group_root import GroupRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class GroupsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py index a3711081..d9155612 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py @@ -29,6 +29,12 @@ from fds.analyticsapi.engines.model.linked_pa_template_summary_root import LinkedPATemplateSummaryRoot from fds.analyticsapi.engines.model.linked_pa_template_update_parameters_root import LinkedPATemplateUpdateParametersRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class LinkedPATemplatesApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/npo_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/npo_optimizer_api.py index 0e5bd6ad..b5f31dfd 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/npo_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/npo_optimizer_api.py @@ -27,6 +27,12 @@ from fds.analyticsapi.engines.model.npo_optimization_parameters_root import NPOOptimizationParametersRoot from fds.analyticsapi.engines.model.object_root import ObjectRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class NPOOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py index 44812edb..ae9d775a 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py @@ -28,6 +28,12 @@ from fds.analyticsapi.engines.model.object_root import ObjectRoot from fds.analyticsapi.engines.model.pa_calculation_parameters_root import PACalculationParametersRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class PACalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py index 45213727..6db2479b 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py @@ -25,6 +25,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.pa_pricing_source_root import PAPricingSourceRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class PricingSourcesApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py index daa6591a..e9bf9d16 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py @@ -27,6 +27,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.pub_calculation_parameters_root import PubCalculationParametersRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class PubCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py index 0cbd1688..e26fe026 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py @@ -28,6 +28,12 @@ from fds.analyticsapi.engines.model.object_root import ObjectRoot from fds.analyticsapi.engines.model.quant_calculation_parameters_root import QuantCalculationParametersRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class QuantCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py index 779c8477..7d68000c 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py @@ -28,6 +28,12 @@ from fds.analyticsapi.engines.model.object_root import ObjectRoot from fds.analyticsapi.engines.model.spar_calculation_parameters_root import SPARCalculationParametersRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class SPARCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py index 4934bd50..fe795052 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py @@ -25,6 +25,12 @@ from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class StrategyDocumentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py index 29853f02..b8ef3183 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py @@ -29,6 +29,12 @@ from fds.analyticsapi.engines.model.templated_pa_component_summary_root import TemplatedPAComponentSummaryRoot from fds.analyticsapi.engines.model.templated_pa_component_update_parameters_root import TemplatedPAComponentUpdateParametersRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class TemplatedPAComponentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py index 4acbe929..865baec9 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py @@ -31,6 +31,12 @@ from fds.analyticsapi.engines.model.unlinked_pa_template_summary_root import UnlinkedPATemplateSummaryRoot from fds.analyticsapi.engines.model.unlinked_pa_template_update_parameters_root import UnlinkedPATemplateUpdateParametersRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class UnlinkedPATemplatesApi(object): """NOTE: This class is auto generated by OpenAPI Generator diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py index 25863675..0fc0ace6 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py @@ -28,6 +28,12 @@ from fds.analyticsapi.engines.model.object_root import ObjectRoot from fds.analyticsapi.engines.model.vault_calculation_parameters_root import VaultCalculationParametersRoot +import warnings + +warnings.warn( + "This library is deprecated. Please use instead.", + DeprecationWarning +) class VaultCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator From 0a0892512eaaf6d47bc21bfac851ebf16e061074 Mon Sep 17 00:00:00 2001 From: factset-sdk-bot Date: Thu, 16 Oct 2025 16:02:19 +0000 Subject: [PATCH 06/10] feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repository PR 70 for SDK version v6.1.0 --- auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py | 1 + .../fds/analyticsapi/engines/api/afi_optimizer_api.py | 1 + .../fds/analyticsapi/engines/api/axp_optimizer_api.py | 1 + .../fds/analyticsapi/engines/api/benchmarks_api.py | 1 + .../fds/analyticsapi/engines/api/bpm_optimizer_api.py | 1 + .../fds/analyticsapi/engines/api/column_statistics_api.py | 1 + auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py | 1 + .../fds/analyticsapi/engines/api/components_api.py | 1 + .../fds/analyticsapi/engines/api/configurations_api.py | 1 + .../fds/analyticsapi/engines/api/currencies_api.py | 1 + auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py | 1 + .../fds/analyticsapi/engines/api/discount_curves_api.py | 1 + auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py | 1 + .../fds/analyticsapi/engines/api/fi_calculations_api.py | 1 + .../fds/analyticsapi/engines/api/fiab_calculations_api.py | 1 + .../fds/analyticsapi/engines/api/fpo_optimizer_api.py | 1 + .../fds/analyticsapi/engines/api/frequencies_api.py | 1 + auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py | 1 + .../fds/analyticsapi/engines/api/linked_pa_templates_api.py | 1 + .../fds/analyticsapi/engines/api/npo_optimizer_api.py | 1 + .../fds/analyticsapi/engines/api/pa_calculations_api.py | 1 + .../fds/analyticsapi/engines/api/pricing_sources_api.py | 1 + .../fds/analyticsapi/engines/api/pub_calculations_api.py | 1 + .../fds/analyticsapi/engines/api/quant_calculations_api.py | 1 + .../fds/analyticsapi/engines/api/spar_calculations_api.py | 1 + .../fds/analyticsapi/engines/api/strategy_documents_api.py | 1 + .../fds/analyticsapi/engines/api/templated_pa_components_api.py | 1 + .../fds/analyticsapi/engines/api/unlinked_pa_templates_api.py | 1 + .../fds/analyticsapi/engines/api/vault_calculations_api.py | 1 + 29 files changed, 29 insertions(+) diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py index 7e2700f7..8e396ba8 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/accounts_api.py @@ -33,6 +33,7 @@ DeprecationWarning ) + class AccountsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/afi_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/afi_optimizer_api.py index bf2033f3..7637650a 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/afi_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/afi_optimizer_api.py @@ -34,6 +34,7 @@ DeprecationWarning ) + class AFIOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/axp_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/axp_optimizer_api.py index 998b3e53..9bd3563d 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/axp_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/axp_optimizer_api.py @@ -34,6 +34,7 @@ DeprecationWarning ) + class AXPOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/benchmarks_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/benchmarks_api.py index 32534fc3..968387e2 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/benchmarks_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/benchmarks_api.py @@ -32,6 +32,7 @@ DeprecationWarning ) + class BenchmarksApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/bpm_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/bpm_optimizer_api.py index 1b68c73b..c26d3b86 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/bpm_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/bpm_optimizer_api.py @@ -34,6 +34,7 @@ DeprecationWarning ) + class BPMOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py index a55cc678..bbd62115 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/column_statistics_api.py @@ -31,6 +31,7 @@ DeprecationWarning ) + class ColumnStatisticsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py index 820a7918..b700e5ee 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/columns_api.py @@ -33,6 +33,7 @@ DeprecationWarning ) + class ColumnsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py index 7751cb86..374ce276 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/components_api.py @@ -35,6 +35,7 @@ DeprecationWarning ) + class ComponentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py index 450f0a26..2982fb22 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/configurations_api.py @@ -33,6 +33,7 @@ DeprecationWarning ) + class ConfigurationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/currencies_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/currencies_api.py index 2253d5f4..0ecd3191 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/currencies_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/currencies_api.py @@ -31,6 +31,7 @@ DeprecationWarning ) + class CurrenciesApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py index 827ead5e..cad982cb 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/dates_api.py @@ -32,6 +32,7 @@ DeprecationWarning ) + class DatesApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/discount_curves_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/discount_curves_api.py index a87110b1..d82521ac 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/discount_curves_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/discount_curves_api.py @@ -32,6 +32,7 @@ DeprecationWarning ) + class DiscountCurvesApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py index eb1c602a..0cf8c18c 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/documents_api.py @@ -32,6 +32,7 @@ DeprecationWarning ) + class DocumentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py index 9e6e8827..d1f071f9 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fi_calculations_api.py @@ -34,6 +34,7 @@ DeprecationWarning ) + class FICalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fiab_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fiab_calculations_api.py index 6cb63dc9..941077ee 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fiab_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fiab_calculations_api.py @@ -33,6 +33,7 @@ DeprecationWarning ) + class FIABCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py index c1d77064..671ec1dd 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/fpo_optimizer_api.py @@ -34,6 +34,7 @@ DeprecationWarning ) + class FPOOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py index 107297c1..23cf8f24 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/frequencies_api.py @@ -31,6 +31,7 @@ DeprecationWarning ) + class FrequenciesApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py index bc6e9fda..e181a7b7 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/groups_api.py @@ -32,6 +32,7 @@ DeprecationWarning ) + class GroupsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py index d9155612..9d3ace4b 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/linked_pa_templates_api.py @@ -36,6 +36,7 @@ DeprecationWarning ) + class LinkedPATemplatesApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/npo_optimizer_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/npo_optimizer_api.py index b5f31dfd..69d7dbaf 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/npo_optimizer_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/npo_optimizer_api.py @@ -34,6 +34,7 @@ DeprecationWarning ) + class NPOOptimizerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py index ae9d775a..421d2ede 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pa_calculations_api.py @@ -35,6 +35,7 @@ DeprecationWarning ) + class PACalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py index 6db2479b..26c46fce 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pricing_sources_api.py @@ -32,6 +32,7 @@ DeprecationWarning ) + class PricingSourcesApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py index e9bf9d16..fbb050b6 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/pub_calculations_api.py @@ -34,6 +34,7 @@ DeprecationWarning ) + class PubCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py index e26fe026..b02492b0 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/quant_calculations_api.py @@ -35,6 +35,7 @@ DeprecationWarning ) + class QuantCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py index 7d68000c..0b237f14 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/spar_calculations_api.py @@ -35,6 +35,7 @@ DeprecationWarning ) + class SPARCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py index fe795052..91046e3f 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/strategy_documents_api.py @@ -32,6 +32,7 @@ DeprecationWarning ) + class StrategyDocumentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py index b8ef3183..e1666562 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/templated_pa_components_api.py @@ -36,6 +36,7 @@ DeprecationWarning ) + class TemplatedPAComponentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py index 865baec9..4fadd94e 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/unlinked_pa_templates_api.py @@ -38,6 +38,7 @@ DeprecationWarning ) + class UnlinkedPATemplatesApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py index 0fc0ace6..931e6c0c 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/api/vault_calculations_api.py @@ -35,6 +35,7 @@ DeprecationWarning ) + class VaultCalculationsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech From 517aa12dc456bbbea41f9a9183a9d3d116f32a16 Mon Sep 17 00:00:00 2001 From: Sainath Nalkari Date: Fri, 17 Oct 2025 12:02:18 +0530 Subject: [PATCH 07/10] dummy commit --- tests/test_linked_pa_templates.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/test_linked_pa_templates.py b/tests/test_linked_pa_templates.py index ac935bbf..6a700dc5 100644 --- a/tests/test_linked_pa_templates.py +++ b/tests/test_linked_pa_templates.py @@ -106,6 +106,7 @@ def test_e_delete_linked_pa_template(self): ) self.assertEqual(response[1], 204, "Response should be 204 - Success") + if __name__ == '__main__': unittest.main() From 6e6b0bbad03fde0ff5bb8aa1768e992b954876f0 Mon Sep 17 00:00:00 2001 From: Sainath Nalkari Date: Fri, 17 Oct 2025 14:27:41 +0530 Subject: [PATCH 08/10] Update test_linked_pa_templates.py --- tests/test_linked_pa_templates.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/tests/test_linked_pa_templates.py b/tests/test_linked_pa_templates.py index fa6ac620..4c9f45a7 100644 --- a/tests/test_linked_pa_templates.py +++ b/tests/test_linked_pa_templates.py @@ -73,12 +73,16 @@ def test_c_update_linked_pa_template(self): linked_pa_template_update_parameters_root = LinkedPATemplateUpdateParametersRoot( data=linked_pa_template_update_parameters ) - response = self.linked_pa_templates_api.update_linked_pa_templates( - id=template_id, linked_pa_template_update_parameters_root=linked_pa_template_update_parameters_root - ) - self.assertEqual(response[1], 200, "Response should be 200 - Success") - self.assertEqual(type(response[0].data), LinkedPATemplatePostSummary, "Response should be of LinkedPATemplatePostSummary type.") - self.assertGreater(len(response[0].data['id']), 0, "Response result should not be an empty list.") + + try: + response = self.linked_pa_templates_api.update_linked_pa_templates( + id=template_id, linked_pa_template_update_parameters_root=linked_pa_template_update_parameters_root + ) + self.assertEqual(response[1], 200, "Response should be 200 - Success") + self.assertEqual(type(response[0].data), LinkedPATemplatePostSummary, "Response should be of LinkedPATemplatePostSummary type.") + self.assertGreater(len(response[0].data['id']), 0, "Response result should not be an empty list.") + except: + self.skipTest("template doesn't exist to fetch") def test_d_get_linked_pa_template_by_id(self): templates = self.linked_pa_templates_api.get_linked_pa_templates( From 772d6486236a38858560113112f47e2310571d8a Mon Sep 17 00:00:00 2001 From: Sainath Nalkari Date: Wed, 22 Oct 2025 18:29:53 +0530 Subject: [PATCH 09/10] Revert "Update test_linked_pa_templates.py" This reverts commit 6e6b0bbad03fde0ff5bb8aa1768e992b954876f0. --- tests/test_linked_pa_templates.py | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/tests/test_linked_pa_templates.py b/tests/test_linked_pa_templates.py index 4c9f45a7..fa6ac620 100644 --- a/tests/test_linked_pa_templates.py +++ b/tests/test_linked_pa_templates.py @@ -73,16 +73,12 @@ def test_c_update_linked_pa_template(self): linked_pa_template_update_parameters_root = LinkedPATemplateUpdateParametersRoot( data=linked_pa_template_update_parameters ) - - try: - response = self.linked_pa_templates_api.update_linked_pa_templates( - id=template_id, linked_pa_template_update_parameters_root=linked_pa_template_update_parameters_root - ) - self.assertEqual(response[1], 200, "Response should be 200 - Success") - self.assertEqual(type(response[0].data), LinkedPATemplatePostSummary, "Response should be of LinkedPATemplatePostSummary type.") - self.assertGreater(len(response[0].data['id']), 0, "Response result should not be an empty list.") - except: - self.skipTest("template doesn't exist to fetch") + response = self.linked_pa_templates_api.update_linked_pa_templates( + id=template_id, linked_pa_template_update_parameters_root=linked_pa_template_update_parameters_root + ) + self.assertEqual(response[1], 200, "Response should be 200 - Success") + self.assertEqual(type(response[0].data), LinkedPATemplatePostSummary, "Response should be of LinkedPATemplatePostSummary type.") + self.assertGreater(len(response[0].data['id']), 0, "Response result should not be an empty list.") def test_d_get_linked_pa_template_by_id(self): templates = self.linked_pa_templates_api.get_linked_pa_templates( From ca02fc140d0966ecec6c62e05e8302cdb2084f29 Mon Sep 17 00:00:00 2001 From: Sainath Nalkari Date: Wed, 22 Oct 2025 19:20:32 +0530 Subject: [PATCH 10/10] corrected messages --- auto-generated-sdk/README.md | 3 +++ auto-generated-sdk/fds/analyticsapi/engines/__init__.py | 6 ++++++ auto-generated-sdk/setup.py | 2 +- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md index 1259988c..580b3912 100644 --- a/auto-generated-sdk/README.md +++ b/auto-generated-sdk/README.md @@ -1,3 +1,6 @@ +## 🚨 THIS PACKAGE IS DEPRECATED! +Please use instead. + # fds.analyticsapi.engines Allow clients to fetch Analytics through APIs. diff --git a/auto-generated-sdk/fds/analyticsapi/engines/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/__init__.py index 0de57337..615c86c7 100644 --- a/auto-generated-sdk/fds/analyticsapi/engines/__init__.py +++ b/auto-generated-sdk/fds/analyticsapi/engines/__init__.py @@ -10,6 +10,12 @@ Generated by: https://openapi-generator.tech """ +import warnings + +warnings.warn( + "This package is deprecated. Please use instead.", + DeprecationWarning +) __version__ = "6.1.0" diff --git a/auto-generated-sdk/setup.py b/auto-generated-sdk/setup.py index 968ace04..5c9eb370 100644 --- a/auto-generated-sdk/setup.py +++ b/auto-generated-sdk/setup.py @@ -42,6 +42,6 @@ include_package_data=True, license="Apache License, Version 2.0", long_description="""\ - Allow clients to fetch Analytics through APIs. # noqa: E501 + This package is deprecated. Please use instead. """ )