├── .github └── workflows │ ├── CI.yml │ └── release.yml ├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── _config.yml ├── auto-generated-sdk ├── .gitignore ├── .gitlab-ci.yml ├── .openapi-generator-ignore ├── .openapi-generator │ ├── FILES │ └── VERSION ├── .travis.yml ├── README.md ├── docs │ ├── AFIOptimizationParameters.md │ ├── AFIOptimizationParametersRoot.md │ ├── AFIOptimizerApi.md │ ├── AFIOptimizerStrategy.md │ ├── AFIOptimizerStrategyOverrides.md │ ├── AXPOptimizerApi.md │ ├── AccountDirectories.md │ ├── AccountDirectoriesRoot.md │ ├── AccountsApi.md │ ├── AxiomaEquityOptimizationParameters.md │ ├── AxiomaEquityOptimizationParametersRoot.md │ ├── AxiomaEquityOptimizerStrategy.md │ ├── AxiomaEquityOptimizerStrategyOverrides.md │ ├── BPMOptimization.md │ ├── BPMOptimizationParameters.md │ ├── BPMOptimizationParametersRoot.md │ ├── BPMOptimizerApi.md │ ├── BPMOptimizerStrategy.md │ ├── BPMOptimizerStrategyAlphaOverride.md │ ├── BPMOptimizerStrategyOverrides.md │ ├── BenchmarksApi.md │ ├── CalculationInfo.md │ ├── CalculationInfoRoot.md │ ├── CalculationMeta.md │ ├── CalculationStatus.md │ ├── CalculationStatusMeta.md │ ├── CalculationStatusRoot.md │ ├── CalculationUnitStatus.md │ ├── CalculationUnitStatusMeta.md │ ├── CalculationsSummary.md │ ├── CalculationsSummaryRoot.md │ ├── ClientErrorResponse.md │ ├── Column.md │ ├── ColumnRoot.md │ ├── ColumnStatistic.md │ ├── ColumnStatisticRoot.md │ ├── ColumnStatisticsApi.md │ ├── ColumnSummary.md │ ├── ColumnSummaryRoot.md │ ├── ColumnsApi.md │ ├── ComponentSummary.md │ ├── ComponentSummaryRoot.md │ ├── ComponentsApi.md │ ├── ConfigurationAccount.md │ ├── ConfigurationsApi.md │ ├── ConstraintAction.md │ ├── CurrenciesApi.md │ ├── Currency.md │ ├── CurrencyRoot.md │ ├── DateParametersSummary.md │ ├── DateParametersSummaryRoot.md │ ├── DatesApi.md │ ├── DiscountCurvesApi.md │ ├── DocumentDirectories.md │ ├── DocumentDirectoriesRoot.md │ ├── DocumentsApi.md │ ├── Error.md │ ├── ErrorSource.md │ ├── EventSummary.md │ ├── FIABCalculationParameters.md │ ├── FIABCalculationStatus.md │ ├── FIABCalculationStatusSummary.md │ ├── FIABCalculationsApi.md │ ├── FIABDateParameters.md │ ├── FIABIdentifier.md │ ├── FIAttributionForJobSettings.md │ ├── FIAttributionForSecurities.md │ ├── FIBalloonExtension.md │ ├── FIBankLoans.md │ ├── FICalculationParameters.md │ ├── FICalculationParametersRoot.md │ ├── FICalculationsApi.md │ ├── FICashflows.md │ ├── FIDiscountCurveInfo.md │ ├── FIDiscountCurveInfoRoot.md │ ├── FIJobSettings.md │ ├── FILoss.md │ ├── FIMarketEnvironment.md │ ├── FIMunicipalBonds.md │ ├── FIMunicipalBondsForJobSettings.md │ ├── FIPrepay.md │ ├── FIPrepayLockout.md │ ├── FIReferencePrepay.md │ ├── FIReferenceSecurity.md │ ├── FISecurity.md │ ├── FIServicerAdvances.md │ ├── FIServicerAdvancesForSecurities.md │ ├── FIStructuredProductsForJobSettings.md │ ├── FIStructuredProductsForSecurities.md │ ├── FPOAccount.md │ ├── FPOObjective.md │ ├── FPOOptimizationParameters.md │ ├── FPOOptimizationParametersRoot.md │ ├── FPOOptimizerApi.md │ ├── FPOOptimizerStrategy.md │ ├── FPOOptimizerStrategyOverrides.md │ ├── FrequenciesApi.md │ ├── Frequency.md │ ├── FrequencyRoot.md │ ├── Group.md │ ├── GroupRoot.md │ ├── GroupsApi.md │ ├── LinkedPATemplate.md │ ├── LinkedPATemplateParameters.md │ ├── LinkedPATemplateParametersRoot.md │ ├── LinkedPATemplatePostSummary.md │ ├── LinkedPATemplatePostSummaryRoot.md │ ├── LinkedPATemplateRoot.md │ ├── LinkedPATemplateSummary.md │ ├── LinkedPATemplateSummaryRoot.md │ ├── LinkedPATemplateUpdateParameters.md │ ├── LinkedPATemplateUpdateParametersRoot.md │ ├── LinkedPATemplatesApi.md │ ├── NPOOptimizationParameters.md │ ├── NPOOptimizationParametersRoot.md │ ├── NPOOptimizerApi.md │ ├── NPOOptimizerStrategy.md │ ├── NPOOptimizerStrategyOverrides.md │ ├── ObjectRoot.md │ ├── OptimalPortfolio.md │ ├── Optimization.md │ ├── OptimizerAccount.md │ ├── OptimizerAccountOverrides.md │ ├── OptimizerOptimalHoldings.md │ ├── OptimizerOutputTypes.md │ ├── OptimizerTradesList.md │ ├── PACalculationColumn.md │ ├── PACalculationDataSources.md │ ├── PACalculationGroup.md │ ├── PACalculationParameters.md │ ├── PACalculationParametersRoot.md │ ├── PACalculationPricingSource.md │ ├── PACalculationsApi.md │ ├── PAComponent.md │ ├── PAComponentData.md │ ├── PAComponentRoot.md │ ├── PADateParameters.md │ ├── PAIdentifier.md │ ├── PAPricingSource.md │ ├── PAPricingSourceRoot.md │ ├── PaDoc.md │ ├── PaginationInfo.md │ ├── PaginationMeta.md │ ├── PricingSourcesApi.md │ ├── PubCalculationParameters.md │ ├── PubCalculationParametersRoot.md │ ├── PubCalculationsApi.md │ ├── PubDateParameters.md │ ├── PubIdentifier.md │ ├── QuantAllUniversalScreenParameters.md │ ├── QuantCalculationMeta.md │ ├── QuantCalculationParameters.md │ ├── QuantCalculationParametersRoot.md │ ├── QuantCalculationsApi.md │ ├── QuantDate.md │ ├── QuantDateList.md │ ├── QuantDateListObsolete.md │ ├── QuantFdsDate.md │ ├── QuantFdsDateObsolete.md │ ├── QuantFormula.md │ ├── QuantFqlExpression.md │ ├── QuantFqlExpressionObsolete.md │ ├── QuantIdentifierUniverse.md │ ├── QuantIdentifierUniverseObsolete.md │ ├── QuantScreeningExpression.md │ ├── QuantScreeningExpressionObsolete.md │ ├── QuantScreeningExpressionUniverse.md │ ├── QuantScreeningExpressionUniverseObsolete.md │ ├── QuantUniversalScreenParameter.md │ ├── QuantUniversalScreenParameterObsolete.md │ ├── QuantUniversalScreenUniverse.md │ ├── QuantUniversalScreenUniverseObsolete.md │ ├── QuantUniverse.md │ ├── ReturnType.md │ ├── SPARAccounts.md │ ├── SPARAccountsRoot.md │ ├── SPARBenchmark.md │ ├── SPARBenchmarkRoot.md │ ├── SPARCalculationParameters.md │ ├── SPARCalculationParametersRoot.md │ ├── SPARCalculationsApi.md │ ├── SPARComponent.md │ ├── SPARComponentRoot.md │ ├── SPARDateParameters.md │ ├── SPARIdentifier.md │ ├── StrategyDocumentsApi.md │ ├── TemplateContentTypes.md │ ├── TemplatedPAComponent.md │ ├── TemplatedPAComponentParameters.md │ ├── TemplatedPAComponentParametersRoot.md │ ├── TemplatedPAComponentPostSummary.md │ ├── TemplatedPAComponentPostSummaryRoot.md │ ├── TemplatedPAComponentRoot.md │ ├── TemplatedPAComponentSummary.md │ ├── TemplatedPAComponentSummaryRoot.md │ ├── TemplatedPAComponentUpdateParameters.md │ ├── TemplatedPAComponentUpdateParametersRoot.md │ ├── TemplatedPAComponentsApi.md │ ├── UnlinkedPATemplate.md │ ├── UnlinkedPATemplateCategoryAndType.md │ ├── UnlinkedPATemplateCategoryAndTypeDetails.md │ ├── UnlinkedPATemplateCategoryAndTypeDetailsRoot.md │ ├── UnlinkedPATemplateCategoryAndTypeRoot.md │ ├── UnlinkedPATemplateColumnDetails.md │ ├── UnlinkedPATemplateGroupDetails.md │ ├── UnlinkedPATemplateParameters.md │ ├── UnlinkedPATemplateParametersRoot.md │ ├── UnlinkedPATemplatePostSummary.md │ ├── UnlinkedPATemplatePostSummaryRoot.md │ ├── UnlinkedPATemplateRoot.md │ ├── UnlinkedPATemplateSummary.md │ ├── UnlinkedPATemplateSummaryRoot.md │ ├── UnlinkedPATemplateUpdateParameters.md │ ├── UnlinkedPATemplateUpdateParametersRoot.md │ ├── UnlinkedPATemplatesApi.md │ ├── VaultCalculationParameters.md │ ├── VaultCalculationParametersRoot.md │ ├── VaultCalculationsApi.md │ ├── VaultComponent.md │ ├── VaultComponentRoot.md │ ├── VaultConfiguration.md │ ├── VaultConfigurationRoot.md │ ├── VaultConfigurationSummary.md │ ├── VaultConfigurationSummaryRoot.md │ ├── VaultDateParameters.md │ └── VaultIdentifier.md ├── fds │ ├── __init__.py │ └── analyticsapi │ │ ├── __init__.py │ │ └── engines │ │ ├── __init__.py │ │ ├── api │ │ ├── __init__.py │ │ ├── accounts_api.py │ │ ├── afi_optimizer_api.py │ │ ├── axp_optimizer_api.py │ │ ├── benchmarks_api.py │ │ ├── bpm_optimizer_api.py │ │ ├── column_statistics_api.py │ │ ├── columns_api.py │ │ ├── components_api.py │ │ ├── configurations_api.py │ │ ├── currencies_api.py │ │ ├── dates_api.py │ │ ├── discount_curves_api.py │ │ ├── documents_api.py │ │ ├── fi_calculations_api.py │ │ ├── fiab_calculations_api.py │ │ ├── fpo_optimizer_api.py │ │ ├── frequencies_api.py │ │ ├── groups_api.py │ │ ├── linked_pa_templates_api.py │ │ ├── npo_optimizer_api.py │ │ ├── pa_calculations_api.py │ │ ├── pricing_sources_api.py │ │ ├── pub_calculations_api.py │ │ ├── quant_calculations_api.py │ │ ├── spar_calculations_api.py │ │ ├── strategy_documents_api.py │ │ ├── templated_pa_components_api.py │ │ ├── unlinked_pa_templates_api.py │ │ └── vault_calculations_api.py │ │ ├── api_client.py │ │ ├── apis │ │ └── __init__.py │ │ ├── configuration.py │ │ ├── exceptions.py │ │ ├── model │ │ ├── __init__.py │ │ ├── account_directories.py │ │ ├── account_directories_root.py │ │ ├── afi_optimization_parameters.py │ │ ├── afi_optimization_parameters_root.py │ │ ├── afi_optimizer_strategy.py │ │ ├── afi_optimizer_strategy_overrides.py │ │ ├── axioma_equity_optimization_parameters.py │ │ ├── axioma_equity_optimization_parameters_root.py │ │ ├── axioma_equity_optimizer_strategy.py │ │ ├── axioma_equity_optimizer_strategy_overrides.py │ │ ├── bpm_optimization.py │ │ ├── bpm_optimization_parameters.py │ │ ├── bpm_optimization_parameters_root.py │ │ ├── bpm_optimizer_strategy.py │ │ ├── bpm_optimizer_strategy_alpha_override.py │ │ ├── bpm_optimizer_strategy_overrides.py │ │ ├── calculation_info.py │ │ ├── calculation_info_root.py │ │ ├── calculation_meta.py │ │ ├── calculation_status.py │ │ ├── calculation_status_meta.py │ │ ├── calculation_status_root.py │ │ ├── calculation_unit_status.py │ │ ├── calculation_unit_status_meta.py │ │ ├── calculations_summary.py │ │ ├── calculations_summary_root.py │ │ ├── client_error_response.py │ │ ├── column.py │ │ ├── column_root.py │ │ ├── column_statistic.py │ │ ├── column_statistic_root.py │ │ ├── column_summary.py │ │ ├── column_summary_root.py │ │ ├── component_summary.py │ │ ├── component_summary_root.py │ │ ├── configuration_account.py │ │ ├── constraint_action.py │ │ ├── currency.py │ │ ├── currency_root.py │ │ ├── date_parameters_summary.py │ │ ├── date_parameters_summary_root.py │ │ ├── document_directories.py │ │ ├── document_directories_root.py │ │ ├── error.py │ │ ├── error_source.py │ │ ├── event_summary.py │ │ ├── fi_attribution_for_job_settings.py │ │ ├── fi_attribution_for_securities.py │ │ ├── fi_balloon_extension.py │ │ ├── fi_bank_loans.py │ │ ├── fi_calculation_parameters.py │ │ ├── fi_calculation_parameters_root.py │ │ ├── fi_cashflows.py │ │ ├── fi_discount_curve_info.py │ │ ├── fi_discount_curve_info_root.py │ │ ├── fi_job_settings.py │ │ ├── fi_loss.py │ │ ├── fi_market_environment.py │ │ ├── fi_municipal_bonds.py │ │ ├── fi_municipal_bonds_for_job_settings.py │ │ ├── fi_prepay.py │ │ ├── fi_prepay_lockout.py │ │ ├── fi_reference_prepay.py │ │ ├── fi_reference_security.py │ │ ├── fi_security.py │ │ ├── fi_servicer_advances.py │ │ ├── fi_servicer_advances_for_securities.py │ │ ├── fi_structured_products_for_job_settings.py │ │ ├── fi_structured_products_for_securities.py │ │ ├── fiab_calculation_parameters.py │ │ ├── fiab_calculation_status.py │ │ ├── fiab_calculation_status_summary.py │ │ ├── fiab_date_parameters.py │ │ ├── fiab_identifier.py │ │ ├── fpo_account.py │ │ ├── fpo_objective.py │ │ ├── fpo_optimization_parameters.py │ │ ├── fpo_optimization_parameters_root.py │ │ ├── fpo_optimizer_strategy.py │ │ ├── fpo_optimizer_strategy_overrides.py │ │ ├── frequency.py │ │ ├── frequency_root.py │ │ ├── group.py │ │ ├── group_root.py │ │ ├── linked_pa_template.py │ │ ├── linked_pa_template_parameters.py │ │ ├── linked_pa_template_parameters_root.py │ │ ├── linked_pa_template_post_summary.py │ │ ├── linked_pa_template_post_summary_root.py │ │ ├── linked_pa_template_root.py │ │ ├── linked_pa_template_summary.py │ │ ├── linked_pa_template_summary_root.py │ │ ├── linked_pa_template_update_parameters.py │ │ ├── linked_pa_template_update_parameters_root.py │ │ ├── npo_optimization_parameters.py │ │ ├── npo_optimization_parameters_root.py │ │ ├── npo_optimizer_strategy.py │ │ ├── npo_optimizer_strategy_overrides.py │ │ ├── object_root.py │ │ ├── optimal_portfolio.py │ │ ├── optimization.py │ │ ├── optimizer_account.py │ │ ├── optimizer_account_overrides.py │ │ ├── optimizer_optimal_holdings.py │ │ ├── optimizer_output_types.py │ │ ├── optimizer_trades_list.py │ │ ├── pa_calculation_column.py │ │ ├── pa_calculation_data_sources.py │ │ ├── pa_calculation_group.py │ │ ├── pa_calculation_parameters.py │ │ ├── pa_calculation_parameters_root.py │ │ ├── pa_calculation_pricing_source.py │ │ ├── pa_component.py │ │ ├── pa_component_data.py │ │ ├── pa_component_root.py │ │ ├── pa_date_parameters.py │ │ ├── pa_doc.py │ │ ├── pa_identifier.py │ │ ├── pa_pricing_source.py │ │ ├── pa_pricing_source_root.py │ │ ├── pagination_info.py │ │ ├── pagination_meta.py │ │ ├── pub_calculation_parameters.py │ │ ├── pub_calculation_parameters_root.py │ │ ├── pub_date_parameters.py │ │ ├── pub_identifier.py │ │ ├── quant_all_universal_screen_parameters.py │ │ ├── quant_calculation_meta.py │ │ ├── quant_calculation_parameters.py │ │ ├── quant_calculation_parameters_root.py │ │ ├── quant_date.py │ │ ├── quant_date_list.py │ │ ├── quant_date_list_obsolete.py │ │ ├── quant_fds_date.py │ │ ├── quant_fds_date_obsolete.py │ │ ├── quant_formula.py │ │ ├── quant_fql_expression.py │ │ ├── quant_fql_expression_obsolete.py │ │ ├── quant_identifier_universe.py │ │ ├── quant_identifier_universe_obsolete.py │ │ ├── quant_screening_expression.py │ │ ├── quant_screening_expression_obsolete.py │ │ ├── quant_screening_expression_universe.py │ │ ├── quant_screening_expression_universe_obsolete.py │ │ ├── quant_universal_screen_parameter.py │ │ ├── quant_universal_screen_parameter_obsolete.py │ │ ├── quant_universal_screen_universe.py │ │ ├── quant_universal_screen_universe_obsolete.py │ │ ├── quant_universe.py │ │ ├── return_type.py │ │ ├── spar_accounts.py │ │ ├── spar_accounts_root.py │ │ ├── spar_benchmark.py │ │ ├── spar_benchmark_root.py │ │ ├── spar_calculation_parameters.py │ │ ├── spar_calculation_parameters_root.py │ │ ├── spar_component.py │ │ ├── spar_component_root.py │ │ ├── spar_date_parameters.py │ │ ├── spar_identifier.py │ │ ├── template_content_types.py │ │ ├── templated_pa_component.py │ │ ├── templated_pa_component_parameters.py │ │ ├── templated_pa_component_parameters_root.py │ │ ├── templated_pa_component_post_summary.py │ │ ├── templated_pa_component_post_summary_root.py │ │ ├── templated_pa_component_root.py │ │ ├── templated_pa_component_summary.py │ │ ├── templated_pa_component_summary_root.py │ │ ├── templated_pa_component_update_parameters.py │ │ ├── templated_pa_component_update_parameters_root.py │ │ ├── unlinked_pa_template.py │ │ ├── unlinked_pa_template_category_and_type.py │ │ ├── unlinked_pa_template_category_and_type_details.py │ │ ├── unlinked_pa_template_category_and_type_details_root.py │ │ ├── unlinked_pa_template_category_and_type_root.py │ │ ├── unlinked_pa_template_column_details.py │ │ ├── unlinked_pa_template_group_details.py │ │ ├── unlinked_pa_template_parameters.py │ │ ├── unlinked_pa_template_parameters_root.py │ │ ├── unlinked_pa_template_post_summary.py │ │ ├── unlinked_pa_template_post_summary_root.py │ │ ├── unlinked_pa_template_root.py │ │ ├── unlinked_pa_template_summary.py │ │ ├── unlinked_pa_template_summary_root.py │ │ ├── unlinked_pa_template_update_parameters.py │ │ ├── unlinked_pa_template_update_parameters_root.py │ │ ├── vault_calculation_parameters.py │ │ ├── vault_calculation_parameters_root.py │ │ ├── vault_component.py │ │ ├── vault_component_root.py │ │ ├── vault_configuration.py │ │ ├── vault_configuration_root.py │ │ ├── vault_configuration_summary.py │ │ ├── vault_configuration_summary_root.py │ │ ├── vault_date_parameters.py │ │ └── vault_identifier.py │ │ ├── model_utils.py │ │ ├── models │ │ └── __init__.py │ │ └── rest.py ├── git_push.sh ├── requirements.txt ├── setup.cfg ├── setup.py ├── test-requirements.txt └── tox.ini ├── examples ├── .pylintrc ├── afi_optimizer_example.py ├── axp_optimizer_example.py ├── bpm_optimizer_example.py ├── examples.pyproj ├── examples.sln ├── fi_example.py ├── fiab_example.py ├── fpo_optimizer_example.py ├── pa_engine_multiple_unit_example.py ├── pa_engine_multiple_unit_linked_templated_component_example.py ├── pa_engine_multiple_unit_unlinked_templated_component_example.py ├── pa_engine_single_unit_example.py ├── pa_engine_single_unit_linked_templated_component_example.py ├── pa_engine_single_unit_unlinked_templated_component_example.py ├── pub_engine_multiple_unit_example.py ├── pub_engine_single_unit_example.py ├── quant_engine_single_unit_feather_example_array_return_type.py ├── quant_engine_single_unit_feather_example_basic.py ├── quant_engine_single_unit_feather_example_fql_expr_univ_expr.py ├── quant_engine_single_unit_feather_example_fql_expr_univ_ids.py ├── quant_engine_single_unit_feather_example_scr_expr_univ_expr.py ├── quant_engine_single_unit_feather_example_scr_expr_univ_ids.py ├── quant_engine_single_unit_feather_example_usc_params_all.py ├── quant_engine_single_unit_feather_example_usc_params_basic.py ├── quant_engine_single_unit_stach_example.py ├── quant_engines_single_unit_feather_example_usc_params_all.py ├── requirements.txt ├── spar_engine_multiple_unit_example.py ├── spar_engine_single_unit_example.py ├── vault_engine_multiple_unit_example.py └── vault_engine_single_unit_example.py └── tests ├── .pylintrc ├── __init__.py ├── api_workflow.py ├── common_functions.py ├── common_parameters.py ├── requirements.txt ├── test_accounts_api.py ├── test_axp_calculations_api.py ├── test_bpm_calculations_api.py ├── test_columns_api.py ├── test_columns_statistics_api.py ├── test_components_api.py ├── test_configurations_api.py ├── test_currencies_api.py ├── test_dates_api.py ├── test_discountcurves_api.py ├── test_documents_api.py ├── test_fi_calculations_api.py ├── test_fiab_calculations_api.py ├── test_fpo_calculations_api.py ├── test_frequencies_api.py ├── test_groups_api.py ├── test_linked_pa_templates.py ├── test_pa_calculations_api.py ├── test_pricing_sources_api.py ├── test_pub_calculations_api.py ├── test_quant_calculations_api.py ├── test_spar_benchmark_api.py ├── test_spar_calculations_api.py ├── test_templated_pa_components.py ├── test_unlinked_pa_templates.py ├── test_vault_calculations_api.py ├── tests.pyproj └── tests.sln /.github/workflows/CI.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | env: 4 | ANALYTICS_API_QAR_USERNAME_SERIAL: ${{ secrets.ANALYTICS_API_QAR_USERNAME_SERIAL }} 5 | ANALYTICS_API_QAR_PASSWORD: ${{ secrets.ANALYTICS_API_QAR_PASSWORD }} 6 | 7 | on: 8 | push: 9 | branches: [ master ] 10 | pull_request: 11 | branches: [ master ] 12 | 13 | jobs: 14 | build: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | 20 | - name: Set up Python 3.8 21 | uses: actions/setup-python@v2 22 | with: 23 | python-version: 3.8 24 | 25 | - name: Build and install new SDK 26 | run: | 27 | python -m pip install --upgrade pip 28 | cd auto-generated-sdk 29 | python setup.py sdist 30 | pip install . 31 | 32 | - name: Build and Run Tests 33 | run: | 34 | cd tests 35 | if [ -f requirements.txt ] 36 | then 37 | pip install -r requirements.txt 38 | fi 39 | python -m unittest discover 40 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | env: 4 | PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }} 5 | PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }} 6 | 7 | on: 8 | release: 9 | types: [ published ] 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | 18 | - name: Set up Python 3.7 19 | uses: actions/setup-python@v2 20 | with: 21 | python-version: 3.7 22 | 23 | - name: Install dependencies 24 | run: | 25 | python -m pip install --upgrade pip 26 | pip install setuptools wheel twine 27 | 28 | - name: Build and publish 29 | env: 30 | TWINE_USERNAME: ${{ env.PYPI_USERNAME }} 31 | TWINE_PASSWORD: ${{ env.PYPI_PASSWORD }} 32 | run: | 33 | cd auto-generated-sdk 34 | python setup.py sdist bdist_wheel 35 | twine upload dist/* 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | FactSet 2 | 3 | # Analytics API Engines Python SDK 4 | 5 | [![build](https://img.shields.io/github/workflow/status/factset/analyticsapi-engines-python-sdk/CI)](https://github.com/factset/analyticsapi-engines-python-sdk/actions?query=workflow%3ACI) 6 | [![PyPi](https://img.shields.io/pypi/v/fds.analyticsapi.engines)](https://pypi.org/project/fds.analyticsapi.engines/) 7 | ![API version](https://img.shields.io/badge/API-v2-blue) 8 | [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0) 9 | 10 | Use this library to integrate with FactSet's Analytics APIs. Below APIs are supported by this SDK. 11 | 12 | * [PA Engine API](https://developer.factset.com/api-catalog/pa-engine-api) 13 | * [SPAR Engine API](https://developer.factset.com/api-catalog/spar-engine-api) 14 | * [Vault API](https://developer.factset.com/api-catalog/vault-api) 15 | 16 | ## Contents 17 | 18 | * [auto-generated-sdk](auto-generated-sdk) - Auto-generated code using [Analytics API Engines SDK Generator](https://github.com/factset/analyticsapi-engines-sdk-generator) 19 | * [examples](examples) - Sample project containing code snippets to quickly get started with the SDK 20 | * [tests](tests) - Integration tests 21 | 22 | ## Requirements 23 | 24 | * Python 3.4 or higher 25 | 26 | ## Installation 27 | 28 | * Install the latest SDK using pip: 29 | 30 | ```sh 31 | pip install fds.analyticsapi.engines 32 | ``` 33 | 34 | * Alternatively, download or clone this repository and install the SDK by running Setuptools in the SDK installation directory: 35 | 36 | ```sh 37 | git clone https://github.com/factset/analyticsapi-engines-python-sdk.git 38 | cd auto-generated-sdk 39 | python setup.py install --user 40 | ``` 41 | 42 | ## Usage 43 | 44 | Refer [examples](examples) project for sample code snippets to quickly get started with the SDK 45 | 46 | ## Tests 47 | 48 | First, clone the repo locally and `cd` into the directory. 49 | 50 | ```sh 51 | git clone https://github.com/factset/analyticsapi-engines-python-sdk.git 52 | ``` 53 | 54 | Then, to make local package in `auto-generated-sdk` accessible to the tests, you have to build and register them in pip 55 | 56 | ```sh 57 | cd auto-generated-sdk/ 58 | python setup.py sdist 59 | pip install . 60 | ``` 61 | 62 | Next, install dependencies that the tests directory needs. 63 | 64 | ```sh 65 | cd tests/ 66 | pip install -r requirements.txt 67 | ``` 68 | 69 | Before running the tests, set the below environment variables. Use the [Developer Portal Manage API Keys page](https://developer.factset.com/manage-api-keys) to get these values. 70 | 71 | ```sh 72 | export ANALYTICS_API_USERNAME_SERIAL = "username-serial" 73 | export ANALYTICS_API_PASSWORD = "apikey" 74 | ``` 75 | 76 | Run the tests with below command. 77 | 78 | ```sh 79 | python -m test 80 | ``` 81 | 82 | **note when checking out different branches, you will have to re-install the auto-generated-sdk directory before running tests again 83 | ```sh 84 | cd auto-generated-sdk/ 85 | pip list # to view what version of fds.analyticsapi.engines is installed 86 | pip uninstall fds.analyticsapi.engines 87 | python setup.py sdist 88 | pip install . 89 | ``` 90 | 91 | ## Contributing 92 | 93 | * Files in [auto-generated-sdk](auto-generated-sdk) directory are auto-generated and should not be manually edited here. Refer [Analytics API Engines SDK Generator](https://github.com/factset/analyticsapi-engines-sdk-generator) for instructions on how to modify these files. 94 | * Projects [examples](examples) and [tests](tests) are open to enhancements and bug fixes. Please create a pull requests with the proposed changes. 95 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-slate -------------------------------------------------------------------------------- /auto-generated-sdk/.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | venv/ 48 | .venv/ 49 | .python-version 50 | .pytest_cache 51 | 52 | # Translations 53 | *.mo 54 | *.pot 55 | 56 | # Django stuff: 57 | *.log 58 | 59 | # Sphinx documentation 60 | docs/_build/ 61 | 62 | # PyBuilder 63 | target/ 64 | 65 | #Ipython Notebook 66 | .ipynb_checkpoints 67 | -------------------------------------------------------------------------------- /auto-generated-sdk/.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | # ref: https://docs.gitlab.com/ee/ci/README.html 2 | 3 | stages: 4 | - test 5 | 6 | .tests: 7 | stage: test 8 | script: 9 | - pip install -r requirements.txt 10 | - pip install -r test-requirements.txt 11 | - pytest --cov=fds.analyticsapi.engines 12 | 13 | test-3.6: 14 | extends: .tests 15 | image: python:3.6-alpine 16 | test-3.7: 17 | extends: .tests 18 | image: python:3.7-alpine 19 | test-3.8: 20 | extends: .tests 21 | image: python:3.8-alpine 22 | test-3.9: 23 | extends: .tests 24 | image: python:3.9-alpine 25 | -------------------------------------------------------------------------------- /auto-generated-sdk/.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # OpenAPI Generator Ignore 2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /auto-generated-sdk/.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 5.1.0 -------------------------------------------------------------------------------- /auto-generated-sdk/.travis.yml: -------------------------------------------------------------------------------- 1 | # ref: https://docs.travis-ci.com/user/languages/python 2 | language: python 3 | python: 4 | - "3.6" 5 | - "3.7" 6 | - "3.8" 7 | - "3.9" 8 | # command to install dependencies 9 | install: 10 | - "pip install -r requirements.txt" 11 | - "pip install -r test-requirements.txt" 12 | # command to run tests 13 | script: pytest --cov=fds.analyticsapi.engines 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AFIOptimizationParameters.md: -------------------------------------------------------------------------------- 1 | # AFIOptimizationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **strategy** | [**AFIOptimizerStrategy**](AFIOptimizerStrategy.md) | | 8 | **output_types** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | 9 | **account** | [**OptimizerAccount**](OptimizerAccount.md) | | [optional] 10 | **optimization** | [**Optimization**](Optimization.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AFIOptimizationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # AFIOptimizationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**AFIOptimizationParameters**](AFIOptimizationParameters.md) | | [optional] 8 | **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AFIOptimizerStrategy.md: -------------------------------------------------------------------------------- 1 | # AFIOptimizerStrategy 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | OptimizerStrategy document path | 8 | **overrides** | [**AFIOptimizerStrategyOverrides**](AFIOptimizerStrategyOverrides.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AFIOptimizerStrategyOverrides.md: -------------------------------------------------------------------------------- 1 | # AFIOptimizerStrategyOverrides 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **objective** | **str** | Objective | [optional] 8 | **tax** | **str** | Tax | [optional] 9 | **constraints** | **{str: (str,)}** | List of constraints | [optional] 10 | **alpha** | **str** | Alpha | [optional] 11 | **transaction_cost** | **str** | Transaction cost | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AccountDirectories.md: -------------------------------------------------------------------------------- 1 | # AccountDirectories 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **accounts** | **[str]** | List of account and composite files. | [optional] 8 | **directories** | **[str]** | List of directories. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AccountDirectoriesRoot.md: -------------------------------------------------------------------------------- 1 | # AccountDirectoriesRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**AccountDirectories**](AccountDirectories.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AxiomaEquityOptimizationParameters.md: -------------------------------------------------------------------------------- 1 | # AxiomaEquityOptimizationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **strategy** | [**AxiomaEquityOptimizerStrategy**](AxiomaEquityOptimizerStrategy.md) | | 8 | **output_types** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | 9 | **account** | [**OptimizerAccount**](OptimizerAccount.md) | | [optional] 10 | **optimization** | [**Optimization**](Optimization.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AxiomaEquityOptimizationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # AxiomaEquityOptimizationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**AxiomaEquityOptimizationParameters**](AxiomaEquityOptimizationParameters.md) | | [optional] 8 | **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AxiomaEquityOptimizerStrategy.md: -------------------------------------------------------------------------------- 1 | # AxiomaEquityOptimizerStrategy 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | OptimizerStrategy document path | 8 | **overrides** | [**AxiomaEquityOptimizerStrategyOverrides**](AxiomaEquityOptimizerStrategyOverrides.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/AxiomaEquityOptimizerStrategyOverrides.md: -------------------------------------------------------------------------------- 1 | # AxiomaEquityOptimizerStrategyOverrides 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **objective** | **str** | Objective | [optional] 8 | **tax** | **str** | Tax | [optional] 9 | **constraints** | **{str: (str,)}** | List of constraints | [optional] 10 | **alpha** | **str** | Alpha | [optional] 11 | **transaction_cost** | **str** | Transaction cost | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/BPMOptimization.md: -------------------------------------------------------------------------------- 1 | # BPMOptimization 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **market** | **str** | Optimization market | [optional] 8 | **invest_all_cash** | **bool** | Optimization invest all cash | [optional] 9 | **risk_model_date** | **str** | Risk model date | [optional] 10 | **backtest_date** | **str** | Backtest date | [optional] 11 | **cashflow** | **str** | Cash flow | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/BPMOptimizationParameters.md: -------------------------------------------------------------------------------- 1 | # BPMOptimizationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **strategy** | [**BPMOptimizerStrategy**](BPMOptimizerStrategy.md) | | 8 | **output_types** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | 9 | **optimization** | [**BPMOptimization**](BPMOptimization.md) | | [optional] 10 | **account** | [**OptimizerAccount**](OptimizerAccount.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/BPMOptimizationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # BPMOptimizationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**BPMOptimizationParameters**](BPMOptimizationParameters.md) | | [optional] 8 | **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/BPMOptimizerStrategy.md: -------------------------------------------------------------------------------- 1 | # BPMOptimizerStrategy 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | OptimizerStrategy document path | 8 | **overrides** | [**BPMOptimizerStrategyOverrides**](BPMOptimizerStrategyOverrides.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/BPMOptimizerStrategyAlphaOverride.md: -------------------------------------------------------------------------------- 1 | # BPMOptimizerStrategyAlphaOverride 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **formula** | **str** | | [optional] 8 | **return_type** | **str** | | [optional] 9 | **return_multiplier** | **str** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/BPMOptimizerStrategyOverrides.md: -------------------------------------------------------------------------------- 1 | # BPMOptimizerStrategyOverrides 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **constraints** | [**[ConstraintAction]**](ConstraintAction.md) | List of constraints | [optional] 8 | **alpha** | [**BPMOptimizerStrategyAlphaOverride**](BPMOptimizerStrategyAlphaOverride.md) | | [optional] 9 | **tax** | **str** | Tax Can be set to \"\" for local | [optional] 10 | **transaction_cost** | **str** | Transaction cost Can be set to \"\" for local | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationInfo.md: -------------------------------------------------------------------------------- 1 | # CalculationInfo 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **calculation_id** | **str** | Calculation identifier | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationInfoRoot.md: -------------------------------------------------------------------------------- 1 | # CalculationInfoRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**CalculationInfo**](CalculationInfo.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationMeta.md: -------------------------------------------------------------------------------- 1 | # CalculationMeta 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **contentorganization** | **str** | | [optional] if omitted the server will use the default value of "SimplifiedRow" 8 | **stach_content_organization** | **str** | | [optional] if omitted the server will use the default value of "SimplifiedRow" 9 | **contenttype** | **str** | | [optional] if omitted the server will use the default value of "Json" 10 | **format** | **str** | | [optional] if omitted the server will use the default value of "JsonStach" 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationStatus.md: -------------------------------------------------------------------------------- 1 | # CalculationStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **calculationid** | **str** | Calculation's identifier | [optional] 8 | **status** | **str** | Calculation's status | [optional] 9 | **units** | [**{str: (CalculationUnitStatus,)}**](CalculationUnitStatus.md) | Number of calculation units in batch. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationStatusMeta.md: -------------------------------------------------------------------------------- 1 | # CalculationStatusMeta 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **units** | [**{str: (CalculationUnitStatusMeta,)}**](CalculationUnitStatusMeta.md) | Meta of calculation units in batch. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationStatusRoot.md: -------------------------------------------------------------------------------- 1 | # CalculationStatusRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**CalculationStatus**](CalculationStatus.md) | | 8 | **meta** | [**CalculationStatusMeta**](CalculationStatusMeta.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationUnitStatus.md: -------------------------------------------------------------------------------- 1 | # CalculationUnitStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **str** | The status of calculation unit. | [optional] 8 | **errors** | [**[Error]**](Error.md) | The error in a calculation unit. | [optional] 9 | **result** | **str** | The result URL of the calculation. | [optional] 10 | **progress** | **str** | The progress of the calculation unit. | [optional] 11 | **points** | **int** | The points for the calculation unit. | [optional] 12 | **warnings** | **[str]** | The warnings in a calculation unit. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationUnitStatusMeta.md: -------------------------------------------------------------------------------- 1 | # CalculationUnitStatusMeta 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **info** | **str** | The Info URL of the calculation. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationsSummary.md: -------------------------------------------------------------------------------- 1 | # CalculationsSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **str** | Last poll status of the calculation. | [optional] 8 | **units** | **int** | Number of calculation units in batch. | [optional] 9 | **request_time** | **datetime** | Request time of calculation. | [optional] 10 | **last_poll_time** | **datetime** | Last poll time of calculation. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CalculationsSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # CalculationsSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (CalculationsSummary,)}**](CalculationsSummary.md) | | 8 | **meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ClientErrorResponse.md: -------------------------------------------------------------------------------- 1 | # ClientErrorResponse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **errors** | [**[Error]**](Error.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/Column.md: -------------------------------------------------------------------------------- 1 | # Column 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **defaultstatisticsids** | **[str]** | Column statistic Id | [optional] 8 | **name** | **str** | Column Name | [optional] 9 | **directory** | **str** | Column Directory | [optional] 10 | **category** | **str** | Column Category | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ColumnRoot.md: -------------------------------------------------------------------------------- 1 | # ColumnRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**Column**](Column.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ColumnStatistic.md: -------------------------------------------------------------------------------- 1 | # ColumnStatistic 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Column Statistic Name | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ColumnStatisticRoot.md: -------------------------------------------------------------------------------- 1 | # ColumnStatisticRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (ColumnStatistic,)}**](ColumnStatistic.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ColumnSummary.md: -------------------------------------------------------------------------------- 1 | # ColumnSummary 2 | 3 | Column settings (name, directory, category) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **str** | Column Name | [optional] 9 | **directory** | **str** | Column Directory | [optional] 10 | **category** | **str** | Column Category | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ColumnSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # ColumnSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (ColumnSummary,)}**](ColumnSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ComponentSummary.md: -------------------------------------------------------------------------------- 1 | # ComponentSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Component name. | [optional] 8 | **category** | **str** | Component category. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ComponentSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # ComponentSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (ComponentSummary,)}**](ComponentSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ConfigurationAccount.md: -------------------------------------------------------------------------------- 1 | # ConfigurationAccount 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **benchmark_code** | **str** | Benchmark code. | [optional] 8 | **benchmark_name** | **str** | Benchmark name. | [optional] 9 | **max_end_date** | **str** | Maximum end date. | [optional] 10 | **min_start_date** | **str** | Minimum start date. | [optional] 11 | **locking_date** | **str** | Locking date. | [optional] 12 | **name** | **str** | Account name. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ConstraintAction.md: -------------------------------------------------------------------------------- 1 | # ConstraintAction 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **item1** | **str** | | [optional] 8 | **item2** | **str** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/Currency.md: -------------------------------------------------------------------------------- 1 | # Currency 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Name of currency. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/CurrencyRoot.md: -------------------------------------------------------------------------------- 1 | # CurrencyRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (Currency,)}**](Currency.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/DateParametersSummary.md: -------------------------------------------------------------------------------- 1 | # DateParametersSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **startdate** | **str** | Start date in YYYYMMDD format. | [optional] 8 | **enddate** | **str** | End date in YYYYMMDD format. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/DateParametersSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # DateParametersSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**DateParametersSummary**](DateParametersSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/DocumentDirectories.md: -------------------------------------------------------------------------------- 1 | # DocumentDirectories 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **documents** | **[str]** | List of documents | [optional] 8 | **directories** | **[str]** | List of directories. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/DocumentDirectoriesRoot.md: -------------------------------------------------------------------------------- 1 | # DocumentDirectoriesRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**DocumentDirectories**](DocumentDirectories.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/Error.md: -------------------------------------------------------------------------------- 1 | # Error 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **code** | **str** | | [optional] 9 | **title** | **str** | | [optional] 10 | **detail** | **str** | | [optional] 11 | **source** | [**ErrorSource**](ErrorSource.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ErrorSource.md: -------------------------------------------------------------------------------- 1 | # ErrorSource 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **pointer** | **str** | | [optional] 8 | **parameter** | **str** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/EventSummary.md: -------------------------------------------------------------------------------- 1 | # EventSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **message** | **str** | Event's message | [optional] 8 | **submissiondatetime** | **datetime** | Event's submission time | [optional] 9 | **type** | **str** | Event's type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIABCalculationParameters.md: -------------------------------------------------------------------------------- 1 | # FIABCalculationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **account** | [**FIABIdentifier**](FIABIdentifier.md) | | 8 | **dates** | [**FIABDateParameters**](FIABDateParameters.md) | | 9 | **fiabdocument** | **str** | FiabDocument (optional) - FIAB document to use as a template. Should be a path to a FIAB document. Expects a GUI-style path (Client:/foo/bar) | [optional] 10 | **msl** | **str** | Master FISecurity List. Analytics results will be written to the selected MSL. Expects a GUI-style path (Client:/foo/bar) | [optional] 11 | **fisettingsdocument** | **str** | FISettingsDocument (optional) - The given @FIS document will be used to configure analytics assumptions and settings. Expects a GUI-style path (Client:/foo/bar) | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIABCalculationStatus.md: -------------------------------------------------------------------------------- 1 | # FIABCalculationStatus 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Calculation's identifier | [optional] 8 | **status** | **str** | Calculation's status | [optional] 9 | **startdatetime** | **datetime** | Start time | [optional] 10 | **completiondatetime** | **datetime** | Completion time | [optional] 11 | **progress** | **int** | Calculation's progress | [optional] 12 | **batchevents** | [**[EventSummary]**](EventSummary.md) | List of batch events | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIABCalculationStatusSummary.md: -------------------------------------------------------------------------------- 1 | # FIABCalculationStatusSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **requesttime** | **datetime** | Request time of calculation. | [optional] 8 | **lastpolltime** | **datetime** | Last poll time of calculation. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIABDateParameters.md: -------------------------------------------------------------------------------- 1 | # FIABDateParameters 2 | 3 | The date parameters for FIAB calculations. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **startdate** | **str** | Calculation's start date. | 9 | **enddate** | **str** | Calculation's end date. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIABIdentifier.md: -------------------------------------------------------------------------------- 1 | # FIABIdentifier 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | User's FactSet account path. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIAttributionForJobSettings.md: -------------------------------------------------------------------------------- 1 | # FIAttributionForJobSettings 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **start_date** | **str** | Start Date | [optional] 8 | **end_date** | **str** | End Date | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIAttributionForSecurities.md: -------------------------------------------------------------------------------- 1 | # FIAttributionForSecurities 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **start_price** | **float** | Start Price | [optional] 8 | **end_price** | **float** | End Price | [optional] 9 | **start_spread** | **float** | Start Spread | [optional] 10 | **end_spread** | **float** | End Spread | [optional] 11 | **pricing_method** | **str** | Pricing Method | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIBalloonExtension.md: -------------------------------------------------------------------------------- 1 | # FIBalloonExtension 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **months** | **int** | Months | [optional] 8 | **percentage** | **float** | Percentage | [optional] 9 | **amortization_type** | **str** | Amortization Type | [optional] 10 | **units** | **str** | Units | [optional] 11 | **coupon_stepup** | **float** | Coupon Stepup | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIBankLoans.md: -------------------------------------------------------------------------------- 1 | # FIBankLoans 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ignore_sinking_fund** | **bool** | Ignore Sinking Fund | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FICalculationParameters.md: -------------------------------------------------------------------------------- 1 | # FICalculationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **securities** | [**[FISecurity]**](FISecurity.md) | List of securities | 8 | **calculations** | **[str]** | List of calculations | 9 | **job_settings** | [**FIJobSettings**](FIJobSettings.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FICalculationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # FICalculationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**FICalculationParameters**](FICalculationParameters.md) | | [optional] 8 | **meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FICashflows.md: -------------------------------------------------------------------------------- 1 | # FICashflows 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **optional_redemption_call_when_units** | **str** | OptionalRedemptionCallWhenUnits | [optional] 8 | **optional_redemption_call_when** | **int** | OptionalRedemptionCallWhen | [optional] 9 | **recovery_lag** | **int** | RecoveryLag | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIDiscountCurveInfo.md: -------------------------------------------------------------------------------- 1 | # FIDiscountCurveInfo 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **category** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **currency** | **str** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIDiscountCurveInfoRoot.md: -------------------------------------------------------------------------------- 1 | # FIDiscountCurveInfoRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (FIDiscountCurveInfo,)}**](FIDiscountCurveInfo.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIJobSettings.md: -------------------------------------------------------------------------------- 1 | # FIJobSettings 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **as_of_date** | **str** | As of date | 8 | **partial_duration_months** | **[int]** | Partial duration months | [optional] 9 | **call_method** | **str** | Call Method | [optional] 10 | **settlement** | **str** | Settlement Date | [optional] 11 | **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] 12 | **bank_loans** | [**FIBankLoans**](FIBankLoans.md) | | [optional] 13 | **municipal_bonds** | [**FIMunicipalBondsForJobSettings**](FIMunicipalBondsForJobSettings.md) | | [optional] 14 | **market_environment** | [**FIMarketEnvironment**](FIMarketEnvironment.md) | | [optional] 15 | **structured_products** | [**FIStructuredProductsForJobSettings**](FIStructuredProductsForJobSettings.md) | | [optional] 16 | **attribution** | [**FIAttributionForJobSettings**](FIAttributionForJobSettings.md) | | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FILoss.md: -------------------------------------------------------------------------------- 1 | # FILoss 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **loss_name** | **str** | Loss Name | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIMarketEnvironment.md: -------------------------------------------------------------------------------- 1 | # FIMarketEnvironment 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **rate_path** | **str** | Rate Path | [optional] if omitted the server will use the default value of "FLAT & FORWARD" 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIMunicipalBonds.md: -------------------------------------------------------------------------------- 1 | # FIMunicipalBonds 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ignore_sinking_fund** | **bool** | Ignore Sinking Fund Schedule | [optional] 8 | **use_anticipated_sink_schedule** | **bool** | Anticipate Sink Schedule | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIMunicipalBondsForJobSettings.md: -------------------------------------------------------------------------------- 1 | # FIMunicipalBondsForJobSettings 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allow_sink_for_installment_payment** | **bool** | Allow Sink For Installment Payment | [optional] 8 | **ignore_sinking_fund** | **bool** | Ignore Sinking Fund Schedule | [optional] 9 | **use_anticipated_sink_schedule** | **bool** | Anticipate Sink Schedule | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIPrepay.md: -------------------------------------------------------------------------------- 1 | # FIPrepay 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **prepay_name** | **str** | Prepay Name | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIPrepayLockout.md: -------------------------------------------------------------------------------- 1 | # FIPrepayLockout 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **points_above** | **str** | Points Above | [optional] 8 | **ym_above** | **str** | Ym Above | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIReferencePrepay.md: -------------------------------------------------------------------------------- 1 | # FIReferencePrepay 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **prepay_name** | **str** | Reference Prepay Name | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIReferenceSecurity.md: -------------------------------------------------------------------------------- 1 | # FIReferenceSecurity 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **security_type** | **str** | Reference Security Type | [optional] 8 | **security_name** | **str** | Reference Security Name | [optional] 9 | **calc_from_method** | **str** | Reference Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix | [optional] 10 | **calc_from_value** | **float** | Reference CalcFromValue | [optional] 11 | **prepay** | [**FIReferencePrepay**](FIReferencePrepay.md) | | [optional] 12 | **settlement** | **str** | Reference Settlement Date | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FISecurity.md: -------------------------------------------------------------------------------- 1 | # FISecurity 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **calc_from_value** | **float** | Calculation from value | 8 | **symbol** | **str** | Symbol | 9 | **settlement** | **str** | Settlement date | [optional] 10 | **call_method** | **str** | Call Method | [optional] 11 | **reference_security** | [**FIReferenceSecurity**](FIReferenceSecurity.md) | | [optional] 12 | **bank_loans** | [**FIBankLoans**](FIBankLoans.md) | | [optional] 13 | **municipal_bonds** | [**FIMunicipalBonds**](FIMunicipalBonds.md) | | [optional] 14 | **loss** | [**FILoss**](FILoss.md) | | [optional] 15 | **prepay** | [**FIPrepay**](FIPrepay.md) | | [optional] 16 | **matrix_spread_adjustment** | **float** | Matrix Spread Adjustment | [optional] 17 | **matrix_multiplier** | **float** | Matrix Multiplier | [optional] 18 | **structured_products** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) | | [optional] 19 | **attribution** | [**FIAttributionForSecurities**](FIAttributionForSecurities.md) | | [optional] 20 | **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] 21 | **face** | **float** | Face | [optional] if omitted the server will use the default value of 1 22 | **face_type** | **str** | Face type | [optional] if omitted the server will use the default value of "Current" 23 | **discount_curve** | **str** | Discount curve | [optional] 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIServicerAdvances.md: -------------------------------------------------------------------------------- 1 | # FIServicerAdvances 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **advance_type** | **str** | Advance Type | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIServicerAdvancesForSecurities.md: -------------------------------------------------------------------------------- 1 | # FIServicerAdvancesForSecurities 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **principal** | **float** | Principal | [optional] 8 | **interest** | **float** | Interest | [optional] 9 | **advance_type** | **str** | Advance Type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIStructuredProductsForJobSettings.md: -------------------------------------------------------------------------------- 1 | # FIStructuredProductsForJobSettings 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **servicer_advances** | [**FIServicerAdvances**](FIServicerAdvances.md) | | [optional] 8 | **ignore_financial_guarantee** | **str** | Ignore Financial Guarantee | [optional] 9 | **clean_up_call_method** | **bool** | Cleanup Call Method | [optional] 10 | **do_opt_redeem** | **str** | Do OPT Redeem | [optional] 11 | **prepay_lockout** | [**FIPrepayLockout**](FIPrepayLockout.md) | | [optional] 12 | **cashflows** | [**FICashflows**](FICashflows.md) | | [optional] 13 | **balloon_extension** | [**FIBalloonExtension**](FIBalloonExtension.md) | | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FIStructuredProductsForSecurities.md: -------------------------------------------------------------------------------- 1 | # FIStructuredProductsForSecurities 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **servicer_advances** | [**FIServicerAdvancesForSecurities**](FIServicerAdvancesForSecurities.md) | | [optional] 8 | **ignore_financial_guarantee** | **str** | Ignore Financial Guarantee | [optional] 9 | **clean_up_call_method** | **bool** | Cleanup Call Method | [optional] 10 | **do_opt_redeem** | **str** | Do OPT Redeem | [optional] 11 | **prepay_lockout** | [**FIPrepayLockout**](FIPrepayLockout.md) | | [optional] 12 | **cashflows** | [**FICashflows**](FICashflows.md) | | [optional] 13 | **balloon_extension** | [**FIBalloonExtension**](FIBalloonExtension.md) | | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FPOAccount.md: -------------------------------------------------------------------------------- 1 | # FPOAccount 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **pa_document** | [**PaDoc**](PaDoc.md) | | 8 | **id** | **str** | Account path | [optional] 9 | **overrides** | [**OptimizerAccountOverrides**](OptimizerAccountOverrides.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FPOObjective.md: -------------------------------------------------------------------------------- 1 | # FPOObjective 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **str** | | [optional] 8 | **terms** | **{str: (str,)}** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FPOOptimizationParameters.md: -------------------------------------------------------------------------------- 1 | # FPOOptimizationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **strategy** | [**FPOOptimizerStrategy**](FPOOptimizerStrategy.md) | | 8 | **output_types** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | 9 | **account** | [**FPOAccount**](FPOAccount.md) | | [optional] 10 | **optimization** | [**Optimization**](Optimization.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FPOOptimizationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # FPOOptimizationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**FPOOptimizationParameters**](FPOOptimizationParameters.md) | | [optional] 8 | **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FPOOptimizerStrategy.md: -------------------------------------------------------------------------------- 1 | # FPOOptimizerStrategy 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | OptimizerStrategy document path | 8 | **overrides** | [**FPOOptimizerStrategyOverrides**](FPOOptimizerStrategyOverrides.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FPOOptimizerStrategyOverrides.md: -------------------------------------------------------------------------------- 1 | # FPOOptimizerStrategyOverrides 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **objective** | [**FPOObjective**](FPOObjective.md) | | [optional] 8 | **constraints** | **{str: (str,)}** | List of constraints | [optional] 9 | **alpha** | **str** | Alpha | [optional] 10 | **transaction_cost** | **str** | Transaction cost | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/Frequency.md: -------------------------------------------------------------------------------- 1 | # Frequency 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Frequency name. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/FrequencyRoot.md: -------------------------------------------------------------------------------- 1 | # FrequencyRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (Frequency,)}**](Frequency.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/Group.md: -------------------------------------------------------------------------------- 1 | # Group 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Group Name | [optional] 8 | **directory** | **str** | Group Directory | [optional] 9 | **category** | **str** | Group Category | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/GroupRoot.md: -------------------------------------------------------------------------------- 1 | # GroupRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (Group,)}**](Group.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplate.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplate 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **directory** | **str** | Template directory. | [optional] 8 | **snapshot** | **bool** | snapshot. | [optional] 9 | **content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] 10 | **id** | **str** | Template id. | [optional] 11 | **description** | **str** | Template description. | [optional] 12 | **name** | **str** | Template name. | [optional] 13 | **parent_component_id** | **str** | Template parent tile. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplateParameters.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplateParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **directory** | **str** | The directory to create a linked PA template | 8 | **parent_component_id** | **str** | Parent component id | 9 | **description** | **str** | Template description | [optional] 10 | **content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplateParametersRoot.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplateParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**LinkedPATemplateParameters**](LinkedPATemplateParameters.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplatePostSummary.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplatePostSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Template id. | [optional] 8 | **description** | **str** | Template description. | [optional] 9 | **name** | **str** | Template name. | [optional] 10 | **parent_component_id** | **str** | Template parent tile. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplatePostSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplatePostSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**LinkedPATemplatePostSummary**](LinkedPATemplatePostSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplateRoot.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplateRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**LinkedPATemplate**](LinkedPATemplate.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplateSummary.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplateSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **str** | Template description. | [optional] 8 | **name** | **str** | Template name. | [optional] 9 | **parent_component_id** | **str** | Template parent tile. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplateSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplateSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (LinkedPATemplateSummary,)}**](LinkedPATemplateSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplateUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplateUpdateParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **parent_component_id** | **str** | Parent component id | [optional] 8 | **description** | **str** | Template description | [optional] 9 | **content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/LinkedPATemplateUpdateParametersRoot.md: -------------------------------------------------------------------------------- 1 | # LinkedPATemplateUpdateParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**LinkedPATemplateUpdateParameters**](LinkedPATemplateUpdateParameters.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/NPOOptimizationParameters.md: -------------------------------------------------------------------------------- 1 | # NPOOptimizationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **strategy** | [**NPOOptimizerStrategy**](NPOOptimizerStrategy.md) | | 8 | **output_types** | [**OptimizerOutputTypes**](OptimizerOutputTypes.md) | | 9 | **account** | [**OptimizerAccount**](OptimizerAccount.md) | | [optional] 10 | **optimization** | [**Optimization**](Optimization.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/NPOOptimizationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # NPOOptimizationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**NPOOptimizationParameters**](NPOOptimizationParameters.md) | | [optional] 8 | **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/NPOOptimizerStrategy.md: -------------------------------------------------------------------------------- 1 | # NPOOptimizerStrategy 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | OptimizerStrategy document path | 8 | **overrides** | [**NPOOptimizerStrategyOverrides**](NPOOptimizerStrategyOverrides.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/NPOOptimizerStrategyOverrides.md: -------------------------------------------------------------------------------- 1 | # NPOOptimizerStrategyOverrides 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **objective** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Objective parameters | [optional] 8 | **constraints** | [**[ConstraintAction]**](ConstraintAction.md) | List of constraints | [optional] 9 | **tax** | **str** | Tax Can be set to \"\" for local | [optional] 10 | **transaction_cost** | **str** | Transaction cost Can be set to \"\" for local | [optional] 11 | **alpha** | **str** | Alpha | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ObjectRoot.md: -------------------------------------------------------------------------------- 1 | # ObjectRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | **bool, date, datetime, dict, float, int, list, str, none_type** | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/OptimalPortfolio.md: -------------------------------------------------------------------------------- 1 | # OptimalPortfolio 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **acct_name** | **str** | Account path | [optional] 8 | **exclude_zero** | **bool** | Exclude zero | [optional] 9 | **archive_date** | **str** | Archive date | [optional] 10 | **if_acct_exists** | **str** | Archive action if account exists | [optional] 11 | **if_ofdb_date_exists** | **str** | Action if ofdb date exists | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/Optimization.md: -------------------------------------------------------------------------------- 1 | # Optimization 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **risk_model_date** | **str** | Risk model date | [optional] 8 | **backtest_date** | **str** | Backtest date | [optional] 9 | **cashflow** | **str** | Cash flow | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/OptimizerAccount.md: -------------------------------------------------------------------------------- 1 | # OptimizerAccount 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Account path | [optional] 8 | **overrides** | [**OptimizerAccountOverrides**](OptimizerAccountOverrides.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/OptimizerAccountOverrides.md: -------------------------------------------------------------------------------- 1 | # OptimizerAccountOverrides 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **portfolio** | **str** | Portfolio | [optional] 8 | **benchmark** | **str** | Benchmark | [optional] 9 | **risk_model_id** | **str** | Risk model | [optional] 10 | **currency** | **str** | Currency | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/OptimizerOptimalHoldings.md: -------------------------------------------------------------------------------- 1 | # OptimizerOptimalHoldings 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **identifier_type** | **str** | Identifier type | [optional] 8 | **include_cash** | **bool** | Include cash | [optional] 9 | **exclude_zero** | **bool** | Exclude zero | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/OptimizerOutputTypes.md: -------------------------------------------------------------------------------- 1 | # OptimizerOutputTypes 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **trades** | [**OptimizerTradesList**](OptimizerTradesList.md) | | [optional] 8 | **optimal** | [**OptimizerOptimalHoldings**](OptimizerOptimalHoldings.md) | | [optional] 9 | **account** | [**OptimalPortfolio**](OptimalPortfolio.md) | | [optional] 10 | **stats** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/OptimizerTradesList.md: -------------------------------------------------------------------------------- 1 | # OptimizerTradesList 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **identifier_type** | **str** | Identifier type | [optional] 8 | **include_cash** | **bool** | Include cash | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PACalculationColumn.md: -------------------------------------------------------------------------------- 1 | # PACalculationColumn 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | FactSet-defined or User-defined Column identifier. | [optional] 8 | **statistics** | **[str]** | Column Statistic identifier | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PACalculationDataSources.md: -------------------------------------------------------------------------------- 1 | # PACalculationDataSources 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **portfoliopricingsources** | [**[PACalculationPricingSource]**](PACalculationPricingSource.md) | List of portfilio pricing source for the PA calculation | [optional] 8 | **benchmarkpricingsources** | [**[PACalculationPricingSource]**](PACalculationPricingSource.md) | List of benchmark pricing source for the PA calculation | [optional] 9 | **useportfoliopricingsourcesforbenchmark** | **bool** | Use portfolio pricing sources for benchmark | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PACalculationGroup.md: -------------------------------------------------------------------------------- 1 | # PACalculationGroup 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | FactSet-defined or User-defined Group identifier. | [optional] 8 | **frequency** | **str** | Grouping frequency | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PACalculationParameters.md: -------------------------------------------------------------------------------- 1 | # PACalculationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **componentid** | **str** | The PA Engine component identifier to analyze. | 8 | **accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts. | [optional] 9 | **benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks. | [optional] 10 | **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] 11 | **groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] 12 | **currencyisocode** | **str** | Currency ISO code for calculation. | [optional] 13 | **columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] 14 | **datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] 15 | **componentdetail** | **str** | Component detail type for the PA component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PACalculationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # PACalculationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (PACalculationParameters,)}**](PACalculationParameters.md) | List of calculation parameters. | [optional] 8 | **meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PACalculationPricingSource.md: -------------------------------------------------------------------------------- 1 | # PACalculationPricingSource 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Pricing source identifier | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PAComponent.md: -------------------------------------------------------------------------------- 1 | # PAComponent 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Component identifier. | [optional] 8 | **accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts saved in the PA document. | [optional] 9 | **benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks saved in the PA document. | [optional] 10 | **currencyisocode** | **str** | | [optional] 11 | **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] 12 | **snapshot** | **bool** | Is the component type snapshot or subperiod. | [optional] 13 | **path** | **str** | The path to the document | [optional] 14 | **name** | **str** | Component name. | [optional] 15 | **category** | **str** | Component category. | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PAComponentData.md: -------------------------------------------------------------------------------- 1 | # PAComponentData 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts. | [optional] 8 | **benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks. | [optional] 9 | **groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation. This will take precedence over the groupings saved in the PA document. | [optional] 10 | **columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation. This will take precedence over the columns saved in the PA document. | [optional] 11 | **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] 12 | **datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] 13 | **currencyisocode** | **str** | Currency ISO code for calculation. | [optional] 14 | **componentdetail** | **str** | PA Storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PAComponentRoot.md: -------------------------------------------------------------------------------- 1 | # PAComponentRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**PAComponent**](PAComponent.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PADateParameters.md: -------------------------------------------------------------------------------- 1 | # PADateParameters 2 | 3 | The date parameters for PA calculation. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **enddate** | **str** | Calculation's end date. | 9 | **frequency** | **str** | Calculation's frequency. | 10 | **startdate** | **str** | Calculation's start date. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PAIdentifier.md: -------------------------------------------------------------------------------- 1 | # PAIdentifier 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | User's FactSet account path OR benchmark. | 8 | **holdingsmode** | **str** | Holdings Mode can be B&H, TBR, OMS , EXT or VLT. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PAPricingSource.md: -------------------------------------------------------------------------------- 1 | # PAPricingSource 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Pricing source Name | [optional] 8 | **directory** | **str** | Pricing source directory | [optional] 9 | **category** | **str** | Pricing source category | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PAPricingSourceRoot.md: -------------------------------------------------------------------------------- 1 | # PAPricingSourceRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (PAPricingSource,)}**](PAPricingSource.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PaDoc.md: -------------------------------------------------------------------------------- 1 | # PaDoc 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | PA document path | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PaginationInfo.md: -------------------------------------------------------------------------------- 1 | # PaginationInfo 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **page_number** | **int** | | [optional] 8 | **page_size** | **int** | | [optional] 9 | **total_pages** | **int** | | [optional] 10 | **total_calculations** | **int** | | [optional] 11 | **next_page** | **str** | | [optional] 12 | **previous_page** | **str** | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PaginationMeta.md: -------------------------------------------------------------------------------- 1 | # PaginationMeta 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **pagination** | [**PaginationInfo**](PaginationInfo.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PubCalculationParameters.md: -------------------------------------------------------------------------------- 1 | # PubCalculationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **document** | **str** | The Publisher Engine document to analyze. | 8 | **account** | [**PubIdentifier**](PubIdentifier.md) | | 9 | **dates** | [**PubDateParameters**](PubDateParameters.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PubCalculationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # PubCalculationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (PubCalculationParameters,)}**](PubCalculationParameters.md) | List of calculation parameters. | [optional] 8 | **meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PubDateParameters.md: -------------------------------------------------------------------------------- 1 | # PubDateParameters 2 | 3 | The date parameters for Publisher calculation. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **enddate** | **str** | Calculation's end date or as of date. | 9 | **startdate** | **str** | Calculation's start date. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/PubIdentifier.md: -------------------------------------------------------------------------------- 1 | # PubIdentifier 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | User's FactSet account path OR benchmark. | 8 | **holdingsmode** | **str** | Holdings Mode can be B&H, TBR, OMS or EXT. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantAllUniversalScreenParameters.md: -------------------------------------------------------------------------------- 1 | # QuantAllUniversalScreenParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **source** | **str** | | 8 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantCalculationMeta.md: -------------------------------------------------------------------------------- 1 | # QuantCalculationMeta 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allow_array_data** | **bool** | | [optional] 8 | **contentorganization** | **str** | | [optional] if omitted the server will use the default value of "SimplifiedRow" 9 | **stach_content_organization** | **str** | | [optional] if omitted the server will use the default value of "SimplifiedRow" 10 | **contenttype** | **str** | | [optional] if omitted the server will use the default value of "Json" 11 | **format** | **str** | | [optional] if omitted the server will use the default value of "JsonStach" 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantCalculationParameters.md: -------------------------------------------------------------------------------- 1 | # QuantCalculationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **universe** | **object** | | [optional] 8 | **dates** | **object** | | [optional] 9 | **formulas** | **[object]** | | [optional] 10 | **job_description** | **str** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantCalculationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # QuantCalculationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (QuantCalculationParameters,)}**](QuantCalculationParameters.md) | List of calculation parameters. | [optional] 8 | **meta** | [**QuantCalculationMeta**](QuantCalculationMeta.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantDate.md: -------------------------------------------------------------------------------- 1 | # QuantDate 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **source** | **str** | | 8 | **frequency** | **str** | | 9 | **calendar** | **str** | | 10 | **override_universal_screen_calendar** | **bool** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantDateList.md: -------------------------------------------------------------------------------- 1 | # QuantDateList 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **source** | **str** | | 8 | **frequency** | **str** | | 9 | **calendar** | **str** | | 10 | **dates** | **[str]** | | [optional] 11 | **override_universal_screen_calendar** | **bool** | | [optional] 12 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantDateListObsolete.md: -------------------------------------------------------------------------------- 1 | # QuantDateListObsolete 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **frequency** | **str** | | 8 | **calendar** | **str** | | 9 | **dates** | **[str]** | | [optional] 10 | **override_universal_screen_calendar** | **bool** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantFdsDate.md: -------------------------------------------------------------------------------- 1 | # QuantFdsDate 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **start_date** | **str** | | 8 | **end_date** | **str** | | 9 | **source** | **str** | | 10 | **frequency** | **str** | | 11 | **calendar** | **str** | | 12 | **override_universal_screen_calendar** | **bool** | | [optional] 13 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantFdsDateObsolete.md: -------------------------------------------------------------------------------- 1 | # QuantFdsDateObsolete 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **start_date** | **str** | | 8 | **end_date** | **str** | | 9 | **frequency** | **str** | | 10 | **calendar** | **str** | | 11 | **override_universal_screen_calendar** | **bool** | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantFormula.md: -------------------------------------------------------------------------------- 1 | # QuantFormula 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **source** | **str** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantFqlExpression.md: -------------------------------------------------------------------------------- 1 | # QuantFqlExpression 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **expr** | **str** | | 8 | **name** | **str** | | 9 | **source** | **str** | | 10 | **date_offset** | **str** | | [optional] 11 | **is_array_return_type** | **bool** | | [optional] 12 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantFqlExpressionObsolete.md: -------------------------------------------------------------------------------- 1 | # QuantFqlExpressionObsolete 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **expr** | **str** | | 8 | **name** | **str** | | 9 | **date_offset** | **str** | | [optional] 10 | **is_array_return_type** | **bool** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantIdentifierUniverse.md: -------------------------------------------------------------------------------- 1 | # QuantIdentifierUniverse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **universe_type** | **str** | | 8 | **identifiers** | **[str]** | | 9 | **source** | **str** | | 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantIdentifierUniverseObsolete.md: -------------------------------------------------------------------------------- 1 | # QuantIdentifierUniverseObsolete 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **universe_type** | **str** | | 8 | **identifiers** | **[str]** | | 9 | **source** | **str** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantScreeningExpression.md: -------------------------------------------------------------------------------- 1 | # QuantScreeningExpression 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **expr** | **str** | | 8 | **name** | **str** | | 9 | **source** | **str** | | 10 | **date_offset** | **str** | | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantScreeningExpressionObsolete.md: -------------------------------------------------------------------------------- 1 | # QuantScreeningExpressionObsolete 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **expr** | **str** | | 8 | **name** | **str** | | 9 | **date_offset** | **str** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantScreeningExpressionUniverse.md: -------------------------------------------------------------------------------- 1 | # QuantScreeningExpressionUniverse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **universe_expr** | **str** | | 8 | **universe_type** | **str** | | 9 | **source** | **str** | | 10 | **security_expr** | **str** | | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantScreeningExpressionUniverseObsolete.md: -------------------------------------------------------------------------------- 1 | # QuantScreeningExpressionUniverseObsolete 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **universe_expr** | **str** | | 8 | **universe_type** | **str** | | 9 | **security_expr** | **str** | | [optional] 10 | **source** | **str** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantUniversalScreenParameter.md: -------------------------------------------------------------------------------- 1 | # QuantUniversalScreenParameter 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **reference_name** | **str** | | 8 | **name** | **str** | | 9 | **source** | **str** | | 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantUniversalScreenParameterObsolete.md: -------------------------------------------------------------------------------- 1 | # QuantUniversalScreenParameterObsolete 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **reference_name** | **str** | | 8 | **name** | **str** | | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantUniversalScreenUniverse.md: -------------------------------------------------------------------------------- 1 | # QuantUniversalScreenUniverse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **screen** | **str** | | 8 | **source** | **str** | | 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantUniversalScreenUniverseObsolete.md: -------------------------------------------------------------------------------- 1 | # QuantUniversalScreenUniverseObsolete 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **screen** | **str** | | 8 | **source** | **str** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/QuantUniverse.md: -------------------------------------------------------------------------------- 1 | # QuantUniverse 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **source** | **str** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/ReturnType.md: -------------------------------------------------------------------------------- 1 | # ReturnType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | | [optional] 8 | **id** | **str** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARAccounts.md: -------------------------------------------------------------------------------- 1 | # SPARAccounts 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **returns_type** | [**[ReturnType]**](ReturnType.md) | List of SPAR returnsType | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARAccountsRoot.md: -------------------------------------------------------------------------------- 1 | # SPARAccountsRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**SPARAccounts**](SPARAccounts.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARBenchmark.md: -------------------------------------------------------------------------------- 1 | # SPARBenchmark 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Benchmark identifier | [optional] 8 | **name** | **str** | Benchmark Name | [optional] 9 | **identifiers** | [**[SPARIdentifier]**](SPARIdentifier.md) | List of SPAR identifiers | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARBenchmarkRoot.md: -------------------------------------------------------------------------------- 1 | # SPARBenchmarkRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**SPARBenchmark**](SPARBenchmark.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARCalculationParameters.md: -------------------------------------------------------------------------------- 1 | # SPARCalculationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **componentid** | **str** | The SPAR Engine component identifier to analyze. | 8 | **accounts** | [**[SPARIdentifier]**](SPARIdentifier.md) | List of accounts for SPAR calculation. | [optional] 9 | **benchmark** | [**SPARIdentifier**](SPARIdentifier.md) | | [optional] 10 | **dates** | [**SPARDateParameters**](SPARDateParameters.md) | | [optional] 11 | **currencyisocode** | **str** | Currency ISO code for calculation. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARCalculationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # SPARCalculationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (SPARCalculationParameters,)}**](SPARCalculationParameters.md) | List of calculation parameters. | [optional] 8 | **meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARComponent.md: -------------------------------------------------------------------------------- 1 | # SPARComponent 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Component identifier. | [optional] 8 | **accounts** | [**[SPARIdentifier]**](SPARIdentifier.md) | List of accounts in SPAR document. | [optional] 9 | **benchmarks** | [**SPARIdentifier**](SPARIdentifier.md) | | [optional] 10 | **currency_iso_code** | **str** | CurrencyCode in SPAR document. | [optional] 11 | **path** | **str** | The path to the document | [optional] 12 | **name** | **str** | Component name. | [optional] 13 | **category** | **str** | Component category. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARComponentRoot.md: -------------------------------------------------------------------------------- 1 | # SPARComponentRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**SPARComponent**](SPARComponent.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARDateParameters.md: -------------------------------------------------------------------------------- 1 | # SPARDateParameters 2 | 3 | The date parameters for SPAR calculation. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **startdate** | **str** | Calculation's start date. | 9 | **enddate** | **str** | Calculation's end date. | 10 | **frequency** | **str** | Calculation's frequency. | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/SPARIdentifier.md: -------------------------------------------------------------------------------- 1 | # SPARIdentifier 2 | 3 | The account/benchmark parameter for SPAR calculation. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | User's FactSet account OR benchmark id. | 9 | **returntype** | **str** | Account or benchmark return type. | [optional] 10 | **prefix** | **str** | Account or benchmark prefix. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplateContentTypes.md: -------------------------------------------------------------------------------- 1 | # TemplateContentTypes 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **mandatory** | **[str]** | Template mandatory fields | [optional] 8 | **optional** | **[str]** | Template optional fields | [optional] 9 | **locked** | **[str]** | Template locked fields | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponent.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponent 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **directory** | **str** | | [optional] 9 | **snapshot** | **bool** | | [optional] 10 | **component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] 11 | **description** | **str** | | [optional] 12 | **name** | **str** | | [optional] 13 | **parent_template_id** | **str** | | [optional] 14 | **type** | **str** | | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentParameters.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **directory** | **str** | Directory to create templated components | 8 | **parent_template_id** | **str** | Parent template id | 9 | **description** | **str** | Component description. | [optional] 10 | **component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentParametersRoot.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**TemplatedPAComponentParameters**](TemplatedPAComponentParameters.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentPostSummary.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentPostSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | | [optional] 8 | **description** | **str** | | [optional] 9 | **name** | **str** | | [optional] 10 | **parent_template_id** | **str** | | [optional] 11 | **type** | **str** | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentPostSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentPostSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**TemplatedPAComponentPostSummary**](TemplatedPAComponentPostSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentRoot.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**TemplatedPAComponent**](TemplatedPAComponent.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentSummary.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **parent_template_id** | **str** | | [optional] 10 | **type** | **str** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (TemplatedPAComponentSummary,)}**](TemplatedPAComponentSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentUpdateParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **parent_template_id** | **str** | Parent template id | [optional] 8 | **description** | **str** | Component description. | [optional] 9 | **component_data** | [**PAComponentData**](PAComponentData.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/TemplatedPAComponentUpdateParametersRoot.md: -------------------------------------------------------------------------------- 1 | # TemplatedPAComponentUpdateParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**TemplatedPAComponentUpdateParameters**](TemplatedPAComponentUpdateParameters.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplate.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplate 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Template id. | [optional] 8 | **directory** | **str** | Template directory. | [optional] 9 | **template_type_id** | **str** | Template type id | [optional] 10 | **snapshot** | **bool** | snapshot. | [optional] 11 | **accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] 12 | **benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] 13 | **columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] 14 | **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] 15 | **groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] 16 | **datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] 17 | **currencyisocode** | **str** | Currency ISO code for calculation. | [optional] 18 | **componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] 19 | **content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] 20 | **description** | **str** | Template description. | [optional] 21 | **name** | **str** | Template name. | [optional] 22 | **category** | **str** | Unlinked template category | [optional] 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | 26 | 27 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndType.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateCategoryAndType 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **category** | **str** | Unlinked template category | [optional] 8 | **name** | **str** | Unlinked template type | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetails.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateCategoryAndTypeDetails 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Type Id | [optional] 8 | **columns** | [**[UnlinkedPATemplateColumnDetails]**](UnlinkedPATemplateColumnDetails.md) | List of default columns | [optional] 9 | **groups** | [**[UnlinkedPATemplateGroupDetails]**](UnlinkedPATemplateGroupDetails.md) | List of default groupings | [optional] 10 | **snapshot** | **bool** | Snapshot | [optional] 11 | **category** | **str** | Unlinked template category | [optional] 12 | **name** | **str** | Unlinked template type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeDetailsRoot.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateCategoryAndTypeDetailsRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**UnlinkedPATemplateCategoryAndTypeDetails**](UnlinkedPATemplateCategoryAndTypeDetails.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateCategoryAndTypeRoot.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateCategoryAndTypeRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (UnlinkedPATemplateCategoryAndType,)}**](UnlinkedPATemplateCategoryAndType.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateColumnDetails.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateColumnDetails 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Unlinked template column name | [optional] 8 | **id** | **str** | FactSet-defined or User-defined Column identifier. | [optional] 9 | **statistics** | **[str]** | Column Statistic identifier | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateGroupDetails.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateGroupDetails 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Unlinked template group name | [optional] 8 | **id** | **str** | FactSet-defined or User-defined Group identifier. | [optional] 9 | **frequency** | **str** | Grouping frequency | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateParameters.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **directory** | **str** | The directory to create an unlinked PA template | 8 | **template_type_id** | **str** | Template type id | 9 | **description** | **str** | Template description | [optional] 10 | **accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] 11 | **benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] 12 | **columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] 13 | **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] 14 | **groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] 15 | **datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] 16 | **currencyisocode** | **str** | Currency ISO code for calculation. | [optional] 17 | **componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] 18 | **content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateParametersRoot.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**UnlinkedPATemplateParameters**](UnlinkedPATemplateParameters.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplatePostSummary.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplatePostSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Template id. | [optional] 8 | **description** | **str** | Template description. | [optional] 9 | **name** | **str** | Template name. | [optional] 10 | **category** | **str** | Unlinked template category | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplatePostSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplatePostSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**UnlinkedPATemplatePostSummary**](UnlinkedPATemplatePostSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateRoot.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**UnlinkedPATemplate**](UnlinkedPATemplate.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateSummary.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **str** | Template description. | [optional] 8 | **name** | **str** | Template name. | [optional] 9 | **category** | **str** | Unlinked template category | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (UnlinkedPATemplateSummary,)}**](UnlinkedPATemplateSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateUpdateParameters.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateUpdateParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **str** | Template description | [optional] 8 | **accounts** | [**[PAIdentifier]**](PAIdentifier.md) | List of accounts | [optional] 9 | **benchmarks** | [**[PAIdentifier]**](PAIdentifier.md) | List of benchmarks | [optional] 10 | **columns** | [**[PACalculationColumn]**](PACalculationColumn.md) | List of columns for the PA calculation | [optional] 11 | **dates** | [**PADateParameters**](PADateParameters.md) | | [optional] 12 | **groups** | [**[PACalculationGroup]**](PACalculationGroup.md) | List of groupings for the PA calculation | [optional] 13 | **datasources** | [**PACalculationDataSources**](PACalculationDataSources.md) | | [optional] 14 | **currencyisocode** | **str** | Currency ISO code for calculation. | [optional] 15 | **componentdetail** | **str** | PA storage type. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] 16 | **content** | [**TemplateContentTypes**](TemplateContentTypes.md) | | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/UnlinkedPATemplateUpdateParametersRoot.md: -------------------------------------------------------------------------------- 1 | # UnlinkedPATemplateUpdateParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**UnlinkedPATemplateUpdateParameters**](UnlinkedPATemplateUpdateParameters.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultCalculationParameters.md: -------------------------------------------------------------------------------- 1 | # VaultCalculationParameters 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **componentid** | **str** | The Vault component identifier to analyze. | 8 | **account** | [**VaultIdentifier**](VaultIdentifier.md) | | 9 | **configid** | **str** | Vault Configuration identifier. | 10 | **dates** | [**VaultDateParameters**](VaultDateParameters.md) | | [optional] 11 | **componentdetail** | **str** | Component detail type for the Vault component. It can be GROUPS or GROUPSALL or TOTALS or SECURITIES. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultCalculationParametersRoot.md: -------------------------------------------------------------------------------- 1 | # VaultCalculationParametersRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (VaultCalculationParameters,)}**](VaultCalculationParameters.md) | List of calculation parameters. | [optional] 8 | **meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultComponent.md: -------------------------------------------------------------------------------- 1 | # VaultComponent 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Vault component identifier | [optional] 8 | **account** | [**VaultIdentifier**](VaultIdentifier.md) | | [optional] 9 | **benchmark** | [**VaultIdentifier**](VaultIdentifier.md) | | [optional] 10 | **currencyisocode** | **str** | Currency iso code saved in the document | [optional] 11 | **dates** | [**VaultDateParameters**](VaultDateParameters.md) | | [optional] 12 | **snapshot** | **bool** | Snapshot | [optional] 13 | **path** | **str** | The path to the document | [optional] 14 | **name** | **str** | Component name. | [optional] 15 | **category** | **str** | Component category. | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultComponentRoot.md: -------------------------------------------------------------------------------- 1 | # VaultComponentRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**VaultComponent**](VaultComponent.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultConfiguration.md: -------------------------------------------------------------------------------- 1 | # VaultConfiguration 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Configuration name. | [optional] 8 | **accounts** | [**{str: (ConfigurationAccount,)}**](ConfigurationAccount.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultConfigurationRoot.md: -------------------------------------------------------------------------------- 1 | # VaultConfigurationRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**VaultConfiguration**](VaultConfiguration.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultConfigurationSummary.md: -------------------------------------------------------------------------------- 1 | # VaultConfigurationSummary 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Configuration name. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultConfigurationSummaryRoot.md: -------------------------------------------------------------------------------- 1 | # VaultConfigurationSummaryRoot 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**{str: (VaultConfigurationSummary,)}**](VaultConfigurationSummary.md) | | 8 | **meta** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultDateParameters.md: -------------------------------------------------------------------------------- 1 | # VaultDateParameters 2 | 3 | The date parameters for Vault calculation 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **enddate** | **str** | Calculation's end date. | 9 | **frequency** | **str** | Calculation's frequency. | 10 | **startdate** | **str** | Calculation's start date. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /auto-generated-sdk/docs/VaultIdentifier.md: -------------------------------------------------------------------------------- 1 | # VaultIdentifier 2 | 3 | The account/benchmark parameter for Vault calculation. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | User's FactSet account path OR benchmark. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /auto-generated-sdk/fds/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/factset/analyticsapi-engines-python-sdk/5f1d227c0b57b9e141e442949484d0720d599243/auto-generated-sdk/fds/__init__.py -------------------------------------------------------------------------------- /auto-generated-sdk/fds/analyticsapi/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/factset/analyticsapi-engines-python-sdk/5f1d227c0b57b9e141e442949484d0720d599243/auto-generated-sdk/fds/analyticsapi/__init__.py -------------------------------------------------------------------------------- /auto-generated-sdk/fds/analyticsapi/engines/__init__.py: -------------------------------------------------------------------------------- 1 | # flake8: noqa 2 | 3 | """ 4 | Engines API 5 | 6 | Allow clients to fetch Analytics through APIs. # noqa: E501 7 | 8 | The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] 9 | Contact: api@factset.com 10 | Generated by: https://openapi-generator.tech 11 | """ 12 | 13 | 14 | __version__ = "6.0.0" 15 | 16 | # import ApiClient 17 | from fds.analyticsapi.engines.api_client import ApiClient 18 | 19 | # import Configuration 20 | from fds.analyticsapi.engines.configuration import Configuration 21 | 22 | # import exceptions 23 | from fds.analyticsapi.engines.exceptions import OpenApiException 24 | from fds.analyticsapi.engines.exceptions import ApiAttributeError 25 | from fds.analyticsapi.engines.exceptions import ApiTypeError 26 | from fds.analyticsapi.engines.exceptions import ApiValueError 27 | from fds.analyticsapi.engines.exceptions import ApiKeyError 28 | from fds.analyticsapi.engines.exceptions import ApiException 29 | -------------------------------------------------------------------------------- /auto-generated-sdk/fds/analyticsapi/engines/api/__init__.py: -------------------------------------------------------------------------------- 1 | # do not import all apis into this module because that uses a lot of memory and stack frames 2 | # if you need the ability to import all apis from one package, import them with 3 | # from fds.analyticsapi.engines.apis import AFIOptimizerApi 4 | -------------------------------------------------------------------------------- /auto-generated-sdk/fds/analyticsapi/engines/apis/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | # flake8: noqa 3 | 4 | # Import all APIs into this package. 5 | # If you have many APIs here with many many models used in each API this may 6 | # raise a `RecursionError`. 7 | # In order to avoid this, import only the API that you directly need like: 8 | # 9 | # from .api.afi_optimizer_api import AFIOptimizerApi 10 | # 11 | # or import this package, but before doing it, use: 12 | # 13 | # import sys 14 | # sys.setrecursionlimit(n) 15 | 16 | # Import APIs into API package: 17 | from fds.analyticsapi.engines.api.afi_optimizer_api import AFIOptimizerApi 18 | from fds.analyticsapi.engines.api.axp_optimizer_api import AXPOptimizerApi 19 | from fds.analyticsapi.engines.api.accounts_api import AccountsApi 20 | from fds.analyticsapi.engines.api.bpm_optimizer_api import BPMOptimizerApi 21 | from fds.analyticsapi.engines.api.benchmarks_api import BenchmarksApi 22 | from fds.analyticsapi.engines.api.column_statistics_api import ColumnStatisticsApi 23 | from fds.analyticsapi.engines.api.columns_api import ColumnsApi 24 | from fds.analyticsapi.engines.api.components_api import ComponentsApi 25 | from fds.analyticsapi.engines.api.configurations_api import ConfigurationsApi 26 | from fds.analyticsapi.engines.api.currencies_api import CurrenciesApi 27 | from fds.analyticsapi.engines.api.dates_api import DatesApi 28 | from fds.analyticsapi.engines.api.discount_curves_api import DiscountCurvesApi 29 | from fds.analyticsapi.engines.api.documents_api import DocumentsApi 30 | from fds.analyticsapi.engines.api.fiab_calculations_api import FIABCalculationsApi 31 | from fds.analyticsapi.engines.api.fi_calculations_api import FICalculationsApi 32 | from fds.analyticsapi.engines.api.fpo_optimizer_api import FPOOptimizerApi 33 | from fds.analyticsapi.engines.api.frequencies_api import FrequenciesApi 34 | from fds.analyticsapi.engines.api.groups_api import GroupsApi 35 | from fds.analyticsapi.engines.api.linked_pa_templates_api import LinkedPATemplatesApi 36 | from fds.analyticsapi.engines.api.npo_optimizer_api import NPOOptimizerApi 37 | from fds.analyticsapi.engines.api.pa_calculations_api import PACalculationsApi 38 | from fds.analyticsapi.engines.api.pricing_sources_api import PricingSourcesApi 39 | from fds.analyticsapi.engines.api.pub_calculations_api import PubCalculationsApi 40 | from fds.analyticsapi.engines.api.quant_calculations_api import QuantCalculationsApi 41 | from fds.analyticsapi.engines.api.spar_calculations_api import SPARCalculationsApi 42 | from fds.analyticsapi.engines.api.strategy_documents_api import StrategyDocumentsApi 43 | from fds.analyticsapi.engines.api.templated_pa_components_api import TemplatedPAComponentsApi 44 | from fds.analyticsapi.engines.api.unlinked_pa_templates_api import UnlinkedPATemplatesApi 45 | from fds.analyticsapi.engines.api.vault_calculations_api import VaultCalculationsApi 46 | -------------------------------------------------------------------------------- /auto-generated-sdk/fds/analyticsapi/engines/model/__init__.py: -------------------------------------------------------------------------------- 1 | # we can not import model classes here because that would create a circular 2 | # reference which would not work in python2 3 | # do not import all models into this module because that uses a lot of memory and stack frames 4 | # if you need the ability to import all models from one package, import them with 5 | # from {{packageName}.models import ModelA, ModelB 6 | -------------------------------------------------------------------------------- /auto-generated-sdk/git_push.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ 3 | # 4 | # Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" 5 | 6 | git_user_id=$1 7 | git_repo_id=$2 8 | release_note=$3 9 | git_host=$4 10 | 11 | if [ "$git_host" = "" ]; then 12 | git_host="github.com" 13 | echo "[INFO] No command line input provided. Set \$git_host to $git_host" 14 | fi 15 | 16 | if [ "$git_user_id" = "" ]; then 17 | git_user_id="GIT_USER_ID" 18 | echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" 19 | fi 20 | 21 | if [ "$git_repo_id" = "" ]; then 22 | git_repo_id="GIT_REPO_ID" 23 | echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" 24 | fi 25 | 26 | if [ "$release_note" = "" ]; then 27 | release_note="Minor update" 28 | echo "[INFO] No command line input provided. Set \$release_note to $release_note" 29 | fi 30 | 31 | # Initialize the local directory as a Git repository 32 | git init 33 | 34 | # Adds the files in the local repository and stages them for commit. 35 | git add . 36 | 37 | # Commits the tracked changes and prepares them to be pushed to a remote repository. 38 | git commit -m "$release_note" 39 | 40 | # Sets the new remote 41 | git_remote=`git remote` 42 | if [ "$git_remote" = "" ]; then # git remote not defined 43 | 44 | if [ "$GIT_TOKEN" = "" ]; then 45 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." 46 | git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git 47 | else 48 | git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git 49 | fi 50 | 51 | fi 52 | 53 | git pull origin master 54 | 55 | # Pushes (Forces) the changes in the local repository up to the remote repository 56 | echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" 57 | git push origin master 2>&1 | grep -v 'To https' 58 | 59 | -------------------------------------------------------------------------------- /auto-generated-sdk/requirements.txt: -------------------------------------------------------------------------------- 1 | python_dateutil >= 2.5.3 2 | setuptools >= 21.0.0 3 | urllib3 >= 1.25.3 4 | fds.protobuf.stach.extensions < 2.0.0 5 | pandas < 2.0.0 6 | openpyxl >= 3.0.0 7 | -------------------------------------------------------------------------------- /auto-generated-sdk/setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length=99 3 | -------------------------------------------------------------------------------- /auto-generated-sdk/setup.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Engines API 5 | 6 | Allow clients to fetch Analytics through APIs. # noqa: E501 7 | 8 | The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab] 9 | Contact: api@factset.com 10 | Generated by: https://openapi-generator.tech 11 | """ 12 | 13 | 14 | from setuptools import setup, find_packages # noqa: H301 15 | 16 | NAME = "fds.analyticsapi.engines" 17 | VERSION = "6.0.0" 18 | # To install the library, run the following 19 | # 20 | # python setup.py install 21 | # 22 | # prerequisite: setuptools 23 | # http://pypi.python.org/pypi/setuptools 24 | 25 | REQUIRES = [ 26 | "urllib3 >= 1.25.3", 27 | "python-dateutil", 28 | "fds.protobuf.stach.extensions < 2.0.0", 29 | ] 30 | 31 | setup( 32 | name=NAME, 33 | version=VERSION, 34 | description="Engines API", 35 | author="FactSet Research Systems", 36 | author_email="api@factset.com", 37 | url="https://github.com/factset/analyticsapi-engines-python-sdk", 38 | keywords=["OpenAPI", "OpenAPI-Generator", "Engines API"], 39 | python_requires=">=3.6", 40 | install_requires=REQUIRES, 41 | packages=find_packages(exclude=["test", "tests"]), 42 | include_package_data=True, 43 | license="Apache License, Version 2.0", 44 | long_description="""\ 45 | Allow clients to fetch Analytics through APIs. # noqa: E501 46 | """ 47 | ) 48 | -------------------------------------------------------------------------------- /auto-generated-sdk/test-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest-cov>=2.8.1 2 | -------------------------------------------------------------------------------- /auto-generated-sdk/tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | pytest --cov=fds.analyticsapi.engines 10 | -------------------------------------------------------------------------------- /examples/examples.pyproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | Debug 4 | 2.0 5 | 67cf4292-b043-48dc-a160-7364b9c2082b 6 | . 7 | multiple_engines_example.py 8 | 9 | 10 | . 11 | . 12 | examples 13 | examples 14 | 15 | 16 | true 17 | false 18 | 19 | 20 | true 21 | false 22 | 23 | 24 | 25 | 26 | 27 | Code 28 | 29 | 30 | Code 31 | 32 | 33 | Code 34 | 35 | 36 | 37 | 40 | 41 | 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /examples/examples.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.28307.572 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{888888A0-9F3D-457C-B088-3A5042F75D52}") = "examples", "examples.pyproj", "{67CF4292-B043-48DC-A160-7364B9C2082B}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {67CF4292-B043-48DC-A160-7364B9C2082B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {67CF4292-B043-48DC-A160-7364B9C2082B}.Release|Any CPU.ActiveCfg = Release|Any CPU 16 | EndGlobalSection 17 | GlobalSection(SolutionProperties) = preSolution 18 | HideSolutionNode = FALSE 19 | EndGlobalSection 20 | GlobalSection(ExtensibilityGlobals) = postSolution 21 | SolutionGuid = {4B7F8A3C-AA28-4260-81F2-51546BEE9D25} 22 | EndGlobalSection 23 | EndGlobal 24 | -------------------------------------------------------------------------------- /examples/fiab_example.py: -------------------------------------------------------------------------------- 1 | import time 2 | import os 3 | import uuid 4 | import pandas as pd 5 | import json 6 | import urllib3 7 | from fds.analyticsapi.engines import ApiException 8 | from fds.analyticsapi.engines.api.fiab_calculations_api import FIABCalculationsApi 9 | from fds.analyticsapi.engines.api_client import ApiClient 10 | from fds.analyticsapi.engines.configuration import Configuration 11 | from fds.analyticsapi.engines.model.fiab_calculation_parameters import FIABCalculationParameters 12 | from fds.analyticsapi.engines.model.fiab_calculation_status_summary import FIABCalculationStatusSummary 13 | from fds.analyticsapi.engines.model.fiab_calculation_status import FIABCalculationStatus 14 | from fds.analyticsapi.engines.model.fiab_date_parameters import FIABDateParameters 15 | from fds.analyticsapi.engines.model.fiab_identifier import FIABIdentifier 16 | from urllib3 import Retry 17 | 18 | urllib3.disable_warnings() 19 | 20 | fds_username = os.environ['FACTSET_USERNAME'] 21 | fds_api_key = os.environ['FACTSET_API_KEY'] 22 | host = os.environ['FACTSET_HOST'] 23 | 24 | 25 | def main(): 26 | config = Configuration() 27 | config.host = host 28 | config.username = fds_username 29 | config.password = fds_api_key 30 | config.discard_unknown_keys = True 31 | # add proxy and/or disable ssl verification according to your development environment 32 | # config.proxy = "" 33 | config.verify_ssl = False 34 | 35 | # Setting configuration to retry api calls on http status codes of 429 and 503. 36 | config.retries = Retry(total=3, status=3, status_forcelist=frozenset([429, 503]), backoff_factor=2, 37 | raise_on_status=False) 38 | 39 | api_client = ApiClient(config) 40 | fiab_calculations_api = FIABCalculationsApi(api_client) 41 | 42 | try: 43 | fiab_document_name = "Client:FIAB_EXPO_DEMO" 44 | faccount = "CLIENT:/Test46238.ACCT" 45 | startdate = "20200101" 46 | enddate = "20201213" 47 | fiab_account = FIABIdentifier(id=faccount) 48 | fiab_dates = FIABDateParameters(startdate=startdate, enddate=enddate) 49 | fiab_calculation_parameters = FIABCalculationParameters(fiabdocument=fiab_document_name, account=fiab_account, dates=fiab_dates) 50 | 51 | run_calculation = fiab_calculations_api.run_calculation(fiab_calculation_parameters=fiab_calculation_parameters) 52 | if run_calculation[1] == 202: 53 | calculation_id = run_calculation[2]['X-FactSet-Api-Calculation-Id'] 54 | print('Calculation Id is ', calculation_id) 55 | status_response = fiab_calculations_api.get_calculation_by_id(calculation_id) 56 | while status_response[1] == 202: 57 | max_age = '5' 58 | age_value = status_response[2].get("cache-control") 59 | if age_value is not None: 60 | max_age = age_value.replace("max-age=", "") 61 | print('Calculation status is', status_response[0]['status']) 62 | #print('Sleeping: ' + max_age) 63 | if(status_response[0]['status']) == 'Pending': 64 | print(status_response) 65 | if(status_response[0]['progress']!=0): 66 | print(status_response[0]) 67 | time.sleep(int(max_age)) 68 | status_response = fiab_calculations_api.get_calculation_by_id(calculation_id) 69 | if status_response[1] == 200: 70 | print(status_response) 71 | print(status_response) 72 | 73 | except ApiException as e: 74 | print("Api exception Encountered") 75 | print(e) 76 | 77 | 78 | if __name__ == '__main__': 79 | main() 80 | -------------------------------------------------------------------------------- /examples/requirements.txt: -------------------------------------------------------------------------------- 1 | astroid==2.5.6 2 | autopep8==1.5.7 3 | certifi==2021.5.30 4 | colorama==0.4.4 5 | fds.protobuf.stach.extensions<2.0.0 6 | fds.protobuf.stach.v2<2.0.0 7 | isort==5.8.0 8 | lazy-object-proxy==1.6.0 9 | mccabe==0.6.1 10 | numpy==1.20.3 11 | pandas==1.2.4 12 | protobuf==3.17.2 13 | pyarrow==4.0.1 14 | pycodestyle==2.7.0 15 | pylint==2.8.3 16 | python-dateutil==2.8.1 17 | pytz==2021.1 18 | six==1.16.0 19 | toml==0.10.2 20 | urllib3==1.26.5 21 | wrapt==1.12.1 22 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/factset/analyticsapi-engines-python-sdk/5f1d227c0b57b9e141e442949484d0720d599243/tests/__init__.py -------------------------------------------------------------------------------- /tests/api_workflow.py: -------------------------------------------------------------------------------- 1 | def run_api_workflow_with_assertions(workflow_specification, current_request, test_context): 2 | current_request_result = current_request(test_context) 3 | if current_request_result is not None and current_request_result["continue_workflow"]: 4 | run_api_workflow_with_assertions( 5 | workflow_specification, 6 | workflow_specification[current_request_result["next_request"]], 7 | current_request_result["test_context"] 8 | ) 9 | -------------------------------------------------------------------------------- /tests/common_functions.py: -------------------------------------------------------------------------------- 1 | from fds.analyticsapi.engines.configuration import Configuration 2 | from fds.analyticsapi.engines.api_client import ApiClient 3 | 4 | import common_parameters 5 | 6 | class CommonFunctions: 7 | 8 | @staticmethod 9 | def build_api_client(): 10 | if (common_parameters.user_name and common_parameters.password): 11 | config = Configuration() 12 | config.host = common_parameters.base_url 13 | config.username = common_parameters.user_name 14 | config.password = common_parameters.password 15 | config.discard_unknown_keys = True 16 | config.verify_ssl = False 17 | 18 | return ApiClient(config) 19 | 20 | raise ValueError("Please set ANALYTICS_API_QAR_USERNAME_SERIAL and ANALYTICS_API_QAR_PASSWORD environment variables.") 21 | -------------------------------------------------------------------------------- /tests/common_parameters.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | # Set 'ANALYTICS_API_QAR_USERNAME_SERIAL' environment variable with username-serial as value 4 | user_name = os.getenv("ANALYTICS_API_QAR_USERNAME_SERIAL") 5 | # Set 'ANALYTICS_API_QAR_PASSWORD' environment variable with the api key generated on developer portal 6 | password = os.getenv("ANALYTICS_API_QAR_PASSWORD") 7 | 8 | # Set 'ANALYTICS_API_URL' environment variable with api url as value 9 | base_url = 'https://api.factset.com' if not os.getenv("ANALYTICS_API_URL") else os.getenv("ANALYTICS_API_URL") 10 | 11 | pa_default_document = "PA_DOCUMENTS:DEFAULT" 12 | pa_default_component_name = "Weights" 13 | pa_default_component_category = "Weights / Exposures" 14 | pa_benchmark_sp500 = "BENCH:SP50" 15 | pa_benchmark_r1000 = "BENCH:R.1000" 16 | spar_default_document = "pmw_root:/spar_documents/Factset Default Document" 17 | spar_benchmark_r1000 = "R.1000" 18 | spar_benchmark_r2000 = "R.2000" 19 | spar_benchmark_russell_p_r1000 = "RUSSELL_P:R.2000" 20 | spar_benchmark_russell_prefix = "RUSSELL" 21 | spar_benchmark_russell_return_type = "GTR" 22 | vault_default_document = "Client:/aapi/VAULT_QA_PI_DEFAULT_LOCKED" 23 | vault_default_account = "CLIENT:/BISAM/REPOSITORY/QA/SMALL_PORT.ACCT" 24 | vault_start_date = "20180101" 25 | vault_end_date = "20180329" 26 | pub_document_name = "Super_client:/publisher/Equity Snapshot.PUB_BRIDGE_PDF" 27 | pub_account_name = "BENCH:SP50" 28 | pub_start_date = "-1M" 29 | pub_end_date = "0M" 30 | default_start_date = "20180101" 31 | default_end_date = "20181231" 32 | default_dates_frequency = "Monthly" 33 | default_dates_account = "CLIENT:/BISAM/REPOSITORY/QA/SMALL_PORT.ACCT" 34 | default_lookup_directory = "client:" 35 | -------------------------------------------------------------------------------- /tests/requirements.txt: -------------------------------------------------------------------------------- 1 | astroid==2.6.2 2 | atomicwrites==1.4.0 3 | attrs==21.2.0 4 | colorama==0.4.4 5 | fds.protobuf.stach<2.0.0 6 | fds.protobuf.stach.extensions<2.0.0 7 | fds.protobuf.stach.v2<2.0.0 8 | iniconfig==1.1.1 9 | isort==5.9.1 10 | lazy-object-proxy==1.6.0 11 | mccabe==0.6.1 12 | packaging==20.9 13 | pandas==1.2.5 14 | pluggy==0.13.1 15 | protobuf==3.17.3 16 | py==1.10.0 17 | pylint==2.9.1 18 | pyparsing==2.4.7 19 | pytest==6.2.4 20 | python-dateutil==2.8.1 21 | pytz==2021.1 22 | six==1.16.0 23 | toml==0.10.2 24 | urllib3==1.26.6 25 | wrapt==1.12.1 26 | -------------------------------------------------------------------------------- /tests/test_accounts_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.accounts_api import AccountsApi 4 | from fds.analyticsapi.engines.model.account_directories_root import AccountDirectoriesRoot 5 | 6 | from common_functions import CommonFunctions 7 | import common_parameters 8 | 9 | 10 | class TestAccountsApi(unittest.TestCase): 11 | 12 | def setUp(self): 13 | self.accounts_api = AccountsApi(CommonFunctions.build_api_client()) 14 | 15 | def test_get_account_list(self): 16 | response = self.accounts_api.get_accounts(common_parameters.default_lookup_directory, _return_http_data_only=False) 17 | self.assertEqual(response[1], 200, "Response code should be 200 - Success") 18 | self.assertEqual(type(response[0]), AccountDirectoriesRoot, "Response should be of AccountDirectoriesRoot type") 19 | 20 | 21 | if __name__ == '__main__': 22 | unittest.main() 23 | -------------------------------------------------------------------------------- /tests/test_axp_calculations_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import time 3 | 4 | from fds.analyticsapi.engines.api.axp_optimizer_api import AXPOptimizerApi 5 | from fds.analyticsapi.engines.model.axioma_equity_optimization_parameters import AxiomaEquityOptimizationParameters 6 | from fds.analyticsapi.engines.model.axioma_equity_optimization_parameters_root import AxiomaEquityOptimizationParametersRoot 7 | from fds.analyticsapi.engines.model.axioma_equity_optimizer_strategy import AxiomaEquityOptimizerStrategy 8 | from fds.analyticsapi.engines.model.axioma_equity_optimizer_strategy_overrides import AxiomaEquityOptimizerStrategyOverrides 9 | from fds.analyticsapi.engines.model.optimizer_account import OptimizerAccount 10 | from fds.analyticsapi.engines.model.optimization import Optimization 11 | from fds.analyticsapi.engines.model.optimizer_trades_list import OptimizerTradesList 12 | from fds.analyticsapi.engines.model.optimizer_output_types import OptimizerOutputTypes 13 | 14 | 15 | from common_functions import CommonFunctions 16 | from api_workflow import run_api_workflow_with_assertions 17 | 18 | 19 | class TestAxpOptimizationsApi(unittest.TestCase): 20 | def setUp(self): 21 | api_client = CommonFunctions.build_api_client() 22 | self.axp_optimizer_api = AXPOptimizerApi(api_client) 23 | 24 | def test_single_unit_scenario(self): 25 | create_step_name = "create_calculation" 26 | read_status_step_name = "read_status" 27 | read_result_step_name = "read_result" 28 | 29 | def create_calculation(test_context): 30 | print("Creating single unit calculation") 31 | axp_strategy = AxiomaEquityOptimizerStrategy(id="Client:/Optimizer/TAXTEST") 32 | axp_account = OptimizerAccount(id="BENCH:SP50") 33 | optimization = Optimization(risk_model_date="09/01/2020",backtest_date="09/01/2020") 34 | trades_list = OptimizerTradesList(identifier_type="SedolChk", include_cash=False) 35 | output_types = OptimizerOutputTypes(trades=trades_list) 36 | 37 | axp_calculation_parameters = AxiomaEquityOptimizationParameters(strategy=axp_strategy, account=axp_account, 38 | optimization=optimization, output_types=output_types) 39 | 40 | axp_calculation_parameter_root = AxiomaEquityOptimizationParametersRoot( 41 | data=axp_calculation_parameters) 42 | 43 | post_and_calculate_response = self.axp_optimizer_api.post_and_optimize( 44 | axioma_equity_optimization_parameters_root=axp_calculation_parameter_root 45 | ) 46 | 47 | self.assertTrue(post_and_calculate_response[1] == 201 or post_and_calculate_response[1] == 202, 48 | "Response for create_calculation should have been 201 or 202") 49 | 50 | if post_and_calculate_response[1] == 201: 51 | return { 52 | "continue_workflow": False, 53 | "next_request": None, 54 | "test_context": None 55 | } 56 | elif post_and_calculate_response[1] == 202: 57 | test_context["calculation_id"] = post_and_calculate_response[2]["X-Factset-Api-Calculation-Id"] 58 | return { 59 | "continue_workflow": True, 60 | "next_request": read_status_step_name, 61 | "test_context": test_context 62 | } 63 | 64 | def read_calculation_status(test_context): 65 | print("Reading single unit calculation status") 66 | calculation_id = test_context["calculation_id"] 67 | print("Calculation Id: " + calculation_id) 68 | 69 | status_response = self.axp_optimizer_api.get_optimization_status_by_id(id=calculation_id) 70 | 71 | self.assertTrue(status_response[1] == 202 or status_response[1] == 201) 72 | 73 | while status_response[1] == 202: 74 | max_age = '5' 75 | age_value = status_response[2].get("cache-control") 76 | if age_value is not None: 77 | max_age = age_value.replace("max-age=", "") 78 | print('Sleeping: ' + max_age) 79 | time.sleep(int(max_age)) 80 | status_response = self.axp_optimizer_api.get_optimization_status_by_id(id=calculation_id) 81 | 82 | return { 83 | "continue_workflow": True, 84 | "next_request": read_result_step_name, 85 | "test_context": test_context 86 | } 87 | 88 | def read_calculation_result(test_context): 89 | calculation_id = test_context["calculation_id"] 90 | result_response = self.axp_optimizer_api.get_optimization_result(id=calculation_id) 91 | self.assertEqual(result_response[1], 200, "Get calculation result should have succeeded") 92 | 93 | workflow_specification = { 94 | create_step_name: create_calculation, 95 | read_status_step_name: read_calculation_status, 96 | read_result_step_name: read_calculation_result 97 | } 98 | starting_request = workflow_specification['create_calculation'] 99 | starting_test_context = {} 100 | run_api_workflow_with_assertions( 101 | workflow_specification, starting_request, starting_test_context) 102 | 103 | 104 | if __name__ == '__main__': 105 | unittest.main(failfast=True) 106 | -------------------------------------------------------------------------------- /tests/test_bpm_calculations_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import time 3 | 4 | from fds.analyticsapi.engines.api.bpm_optimizer_api import BPMOptimizerApi 5 | from fds.analyticsapi.engines.model.bpm_optimization_parameters import BPMOptimizationParameters 6 | from fds.analyticsapi.engines.model.bpm_optimization_parameters_root import BPMOptimizationParametersRoot 7 | from fds.analyticsapi.engines.model.bpm_optimizer_strategy import BPMOptimizerStrategy 8 | from fds.analyticsapi.engines.model.bpm_optimizer_strategy_overrides import BPMOptimizerStrategyOverrides 9 | from fds.analyticsapi.engines.model.optimizer_account import OptimizerAccount 10 | from fds.analyticsapi.engines.model.bpm_optimization import BPMOptimization 11 | from fds.analyticsapi.engines.model.optimizer_trades_list import OptimizerTradesList 12 | from fds.analyticsapi.engines.model.optimizer_output_types import OptimizerOutputTypes 13 | 14 | 15 | from common_functions import CommonFunctions 16 | from api_workflow import run_api_workflow_with_assertions 17 | 18 | 19 | class TestBpmOptimizationsApi(unittest.TestCase): 20 | def setUp(self): 21 | api_client = CommonFunctions.build_api_client() 22 | self.bpm_optimizer_api = BPMOptimizerApi(api_client) 23 | 24 | def test_single_unit_scenario(self): 25 | create_step_name = "create_calculation" 26 | read_status_step_name = "read_status" 27 | read_result_step_name = "read_result" 28 | 29 | def create_calculation(test_context): 30 | print("Creating single unit calculation") 31 | bpm_strategy = BPMOptimizerStrategy(id="CLIENT:/Aapi/Optimizers/BPMAPISIMPLE") 32 | bpm_account = OptimizerAccount(id="BENCH:SP50") 33 | optimization = BPMOptimization(risk_model_date="09/01/2008",backtest_date="09/01/2008") 34 | trades_list = OptimizerTradesList(identifier_type="Asset", include_cash=False) 35 | output_types = OptimizerOutputTypes(trades=trades_list) 36 | 37 | bpm_calculation_parameters = BPMOptimizationParameters(strategy=bpm_strategy, account=bpm_account, 38 | optimization=optimization, output_types=output_types) 39 | 40 | bpm_calculation_parameter_root = BPMOptimizationParametersRoot( 41 | data=bpm_calculation_parameters) 42 | 43 | post_and_calculate_response = self.bpm_optimizer_api.post_and_optimize( 44 | bpm_optimization_parameters_root=bpm_calculation_parameter_root 45 | ) 46 | 47 | self.assertTrue(post_and_calculate_response[1] == 201 or post_and_calculate_response[1] == 202, 48 | "Response for create_calculation should have been 201 or 202") 49 | 50 | if post_and_calculate_response[1] == 201: 51 | return { 52 | "continue_workflow": False, 53 | "next_request": None, 54 | "test_context": None 55 | } 56 | elif post_and_calculate_response[1] == 202: 57 | test_context["calculation_id"] = post_and_calculate_response[2]["X-Factset-Api-Calculation-Id"] 58 | return { 59 | "continue_workflow": True, 60 | "next_request": read_status_step_name, 61 | "test_context": test_context 62 | } 63 | 64 | def read_calculation_status(test_context): 65 | print("Reading single unit calculation status") 66 | calculation_id = test_context["calculation_id"] 67 | print("Calculation Id: " + calculation_id) 68 | 69 | status_response = self.bpm_optimizer_api.get_optimization_status_by_id(id=calculation_id) 70 | 71 | self.assertTrue(status_response[1] == 202 or status_response[1] == 201) 72 | 73 | while status_response[1] == 202: 74 | max_age = '5' 75 | age_value = status_response[2].get("cache-control") 76 | if age_value is not None: 77 | max_age = age_value.replace("max-age=", "") 78 | print('Sleeping: ' + max_age) 79 | time.sleep(int(max_age)) 80 | status_response = self.bpm_optimizer_api.get_optimization_status_by_id(id=calculation_id) 81 | 82 | return { 83 | "continue_workflow": True, 84 | "next_request": read_result_step_name, 85 | "test_context": test_context 86 | } 87 | 88 | def read_calculation_result(test_context): 89 | calculation_id = test_context["calculation_id"] 90 | result_response = self.bpm_optimizer_api.get_optimization_result(id=calculation_id) 91 | self.assertEqual(result_response[1], 200, "Get calculation result should have succeeded") 92 | 93 | workflow_specification = { 94 | create_step_name: create_calculation, 95 | read_status_step_name: read_calculation_status, 96 | read_result_step_name: read_calculation_result 97 | } 98 | starting_request = workflow_specification['create_calculation'] 99 | starting_test_context = {} 100 | run_api_workflow_with_assertions( 101 | workflow_specification, starting_request, starting_test_context) 102 | 103 | 104 | if __name__ == '__main__': 105 | unittest.main(failfast=True) 106 | -------------------------------------------------------------------------------- /tests/test_columns_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.columns_api import ColumnsApi 4 | from fds.analyticsapi.engines.model.column import Column 5 | from fds.analyticsapi.engines.model.column_summary import ColumnSummary 6 | 7 | from common_functions import CommonFunctions 8 | 9 | 10 | class TestColumnsApi(unittest.TestCase): 11 | 12 | def setUp(self): 13 | self.columns_api = ColumnsApi(CommonFunctions.build_api_client()) 14 | 15 | def test_get_all_pa_columns(self): 16 | response = self.columns_api.get_pa_columns( 17 | _return_http_data_only=False) 18 | self.assertEqual(response[1], 200, 19 | "Response code should be 200 - Success") 20 | self.assertEqual( 21 | type(response[0]['data']), dict, "Response should be of Dictionary type") 22 | self.assertEqual(type(response[0]['data'][list(response[0]['data'].keys())[ 23 | 0]]), ColumnSummary, "Response should be of ColumnSummary type") 24 | 25 | def test_get_pa_column_details_by_id(self): 26 | columns = self.columns_api.get_pa_columns(_return_http_data_only=True) 27 | column_id = list(columns.data.keys())[0] 28 | response = self.columns_api.get_pa_column_by_id( 29 | column_id, _return_http_data_only=False) 30 | self.assertEqual(response[1], 200, 31 | "Response code should be 200 - Success") 32 | self.assertEqual(type(response[0]['data']), 33 | Column, "Response should be of Column type") 34 | 35 | 36 | if __name__ == '__main__': 37 | unittest.main() 38 | -------------------------------------------------------------------------------- /tests/test_columns_statistics_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.column_statistics_api import ColumnStatisticsApi 4 | from fds.analyticsapi.engines.model.column_statistic import ColumnStatistic 5 | from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot 6 | 7 | from common_functions import CommonFunctions 8 | 9 | 10 | class TestColumnStatisticsApi(unittest.TestCase): 11 | def setUp(self): 12 | self.column_statistics_api = ColumnStatisticsApi( 13 | CommonFunctions.build_api_client()) 14 | 15 | def test_get_column_statistics(self): 16 | response = self.column_statistics_api.get_pa_column_statistics( 17 | _return_http_data_only=False) 18 | self.assertEqual(response[1], 200, 19 | "Response code should be 200 - Success") 20 | self.assertEqual(type(response[0]), ColumnStatisticRoot, 21 | "Response should be of ColumnStatisticRoot type") 22 | self.assertEqual( 23 | type(response[0]['data'][list(response[0]['data'].keys())[0]]), 24 | ColumnStatistic, 25 | "Response should be of ColumnStatistic type" 26 | ) 27 | 28 | 29 | if __name__ == '__main__': 30 | unittest.main() 31 | -------------------------------------------------------------------------------- /tests/test_configurations_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.configurations_api import ConfigurationsApi 4 | from fds.analyticsapi.engines.model.vault_configuration_summary import VaultConfigurationSummary 5 | from fds.analyticsapi.engines.model.vault_configuration import VaultConfiguration 6 | 7 | import common_parameters 8 | from common_functions import CommonFunctions 9 | 10 | 11 | class TestVaultConfigurations(unittest.TestCase): 12 | 13 | def setUp(self): 14 | self.configurations_api = ConfigurationsApi( 15 | CommonFunctions.build_api_client()) 16 | 17 | def test_get_all_vault_configurations(self): 18 | response = self.configurations_api.get_vault_configurations(account=common_parameters.vault_default_account, 19 | _return_http_data_only=False) 20 | configuration_id = list(response[0].data.keys())[0] 21 | self.assertEqual(response[1], 200, 22 | "Response code should be 200 - Success") 23 | self.assertEqual(type(response[0].data), dict, 24 | "Response should be of Dictionary type") 25 | self.assertEqual(type(response[0].data[configuration_id]), VaultConfigurationSummary, 26 | "Response should be of VaultConfigurationSummary type") 27 | 28 | def test_get_vault_configuration_by_id(self): 29 | response = self.configurations_api.get_vault_configurations( 30 | account=common_parameters.vault_default_account, 31 | _return_http_data_only=True) 32 | configuration_id = list(response.data.keys())[0] 33 | response = self.configurations_api.get_vault_configuration_by_id(configuration_id, 34 | _return_http_data_only=False) 35 | self.assertEqual(response[1], 200, 36 | "Response code should be 200 - Success") 37 | self.assertEqual(type(response[0].data), VaultConfiguration, 38 | "Response should be of VaultConfiguration type") 39 | 40 | 41 | if __name__ == '__main__': 42 | unittest.main() 43 | -------------------------------------------------------------------------------- /tests/test_currencies_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.currencies_api import CurrenciesApi 4 | from fds.analyticsapi.engines.model.currency import Currency 5 | 6 | from common_functions import CommonFunctions 7 | 8 | 9 | class TestCurrenciesApi(unittest.TestCase): 10 | 11 | def setUp(self): 12 | self.currencies_api = CurrenciesApi(CommonFunctions.build_api_client()) 13 | 14 | def test_get_all_currencies(self): 15 | response = self.currencies_api.get_currencies( 16 | _return_http_data_only=False) 17 | currency_code = list(response[0].data.keys())[0] 18 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 19 | self.assertEqual(type(response[0].data), dict, 20 | "Response should be of Dictionary type.") 21 | self.assertEqual(type(response[0].data[currency_code]), 22 | Currency, "Response should be of Currency type.") 23 | self.assertGreater( 24 | len(response[0].data), 0, "Response result should not be an empty list.") 25 | 26 | 27 | if __name__ == '__main__': 28 | unittest.main() 29 | -------------------------------------------------------------------------------- /tests/test_dates_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.dates_api import DatesApi 4 | from fds.analyticsapi.engines.api.components_api import ComponentsApi 5 | 6 | import common_parameters 7 | from common_functions import CommonFunctions 8 | 9 | 10 | class TestDatesApi(unittest.TestCase): 11 | def setUp(self): 12 | self.dates_api = DatesApi(CommonFunctions.build_api_client()) 13 | 14 | def test_convert_pa_date_to_absolute_format(self): 15 | end_date = "-1M" 16 | # hard coding this as we won't know if the component requires start date 17 | component_id = "918EE8207D259B54E2FDE2AAA4D3BEA9248164123A904F298B8438B76F9292EB" 18 | account = common_parameters.default_dates_account 19 | response = self.dates_api.convert_pa_dates_to_absolute_format( 20 | end_date, 21 | component_id, 22 | account, 23 | _return_http_data_only=False 24 | ) 25 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 26 | self.assertNotEqual(response[0], None, 27 | "Response data should not be null") 28 | 29 | def test_convert_vault_date_to_absolute_format(self): 30 | end_date = "-1M" 31 | components_api = ComponentsApi(CommonFunctions.build_api_client()) 32 | components = components_api.get_vault_components( 33 | document=common_parameters.vault_default_document, 34 | _return_http_data_only=True) 35 | component_id = list(components.data.keys())[0] 36 | account = common_parameters.default_dates_account 37 | response = self.dates_api.convert_vault_dates_to_absolute_format( 38 | end_date, 39 | component_id, 40 | account, 41 | _return_http_data_only=False 42 | ) 43 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 44 | self.assertNotEqual(response[0], None, 45 | "Response data should not be null") 46 | 47 | 48 | if __name__ == '__main__': 49 | unittest.main() 50 | -------------------------------------------------------------------------------- /tests/test_discountcurves_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import sys 3 | 4 | from fds.analyticsapi.engines.api.discount_curves_api import DiscountCurvesApi 5 | from fds.analyticsapi.engines.model.fi_discount_curve_info_root import FIDiscountCurveInfoRoot 6 | 7 | from common_functions import CommonFunctions 8 | 9 | 10 | class TestDiscountCurvesApi(unittest.TestCase): 11 | 12 | def setUp(self): 13 | self.discount_curves_api = DiscountCurvesApi(CommonFunctions.build_api_client()) 14 | 15 | def test_get_all_discount_curves(self): 16 | response = self.discount_curves_api.get_all_fi_discount_curves() 17 | currency_code = list(response[0].data.keys())[0] 18 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 19 | self.assertEqual(type(response[0].data), dict, 20 | "Response should be of Dictionary type.") 21 | self.assertGreater( 22 | len(response[0].data), 0, "Response result should not be an empty list.") 23 | 24 | def test_get_all_discount_curves_currency_usd(self): 25 | response = self.discount_curves_api.get_all_fi_discount_curves(currency = "INR") 26 | currency_code = list(response[0].data.keys())[0] 27 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 28 | self.assertEqual(type(response[0].data), dict, 29 | "Response should be of Dictionary type.") 30 | self.assertGreater( 31 | len(response[0].data), 0, "Response result should not be an empty list.") 32 | 33 | def test_get_all_discount_curves_currency_invalid_currency(self): 34 | try: 35 | self.discount_curves_api.get_all_fi_discount_curves(currency = "invalidcurrency") 36 | except Exception as e: 37 | self.assertEqual(type(e).__name__, "NotFoundException", "Response should be 404 - Not Found") 38 | 39 | if __name__ == '__main__': 40 | unittest.main() 41 | -------------------------------------------------------------------------------- /tests/test_documents_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.documents_api import DocumentsApi 4 | from fds.analyticsapi.engines.model.document_directories import DocumentDirectories 5 | 6 | import common_parameters 7 | from common_functions import CommonFunctions 8 | 9 | 10 | class TestDocumentsApi(unittest.TestCase): 11 | 12 | def setUp(self): 13 | self.documents_api = DocumentsApi(CommonFunctions.build_api_client()) 14 | 15 | def test_get_pa_document_list(self): 16 | response = self.documents_api.get_pa3_documents( 17 | common_parameters.default_lookup_directory, _return_http_data_only=False) 18 | self.assertEqual(response[1], 200, 19 | "Response code should be 200 - Success") 20 | self.assertEqual(type(response[0].data), DocumentDirectories, 21 | "Response should be of DocumentDirectories type") 22 | 23 | def test_get_spar_document_list(self): 24 | response = self.documents_api.get_spar3_documents( 25 | common_parameters.default_lookup_directory, _return_http_data_only=False) 26 | self.assertEqual(response[1], 200, 27 | "Response code should be 200 - Success") 28 | self.assertEqual(type(response[0].data), DocumentDirectories, 29 | "Response should be of DocumentDirectories type") 30 | 31 | def test_get_vault_document_list(self): 32 | response = self.documents_api.get_vault_documents( 33 | common_parameters.default_lookup_directory, _return_http_data_only=False) 34 | self.assertEqual(response[1], 200, 35 | "Response code should be 200 - Success") 36 | self.assertEqual(type(response[0].data), DocumentDirectories, 37 | "Response should be of DocumentDirectories type") 38 | 39 | def test_get_pub_document_list(self): 40 | response = self.documents_api.get_pub_documents( 41 | common_parameters.default_lookup_directory, _return_http_data_only=False) 42 | self.assertEqual(response[1], 200, 43 | "Response code should be 200 - Success") 44 | self.assertEqual(type(response[0].data), DocumentDirectories, 45 | "Response should be of DocumentDirectories type") 46 | 47 | 48 | if __name__ == '__main__': 49 | unittest.main() 50 | -------------------------------------------------------------------------------- /tests/test_fi_calculations_api.py: -------------------------------------------------------------------------------- 1 | import time 2 | import unittest 3 | 4 | from fds.analyticsapi.engines.api.fi_calculations_api import FICalculationsApi 5 | from fds.analyticsapi.engines.model.fi_calculation_parameters import FICalculationParameters 6 | from fds.analyticsapi.engines.model.fi_calculation_parameters_root import FICalculationParametersRoot 7 | from fds.analyticsapi.engines.model.fi_security import FISecurity 8 | from fds.analyticsapi.engines.model.fi_job_settings import FIJobSettings 9 | from fds.analyticsapi.engines.model.fi_bank_loans import FIBankLoans 10 | from fds.analyticsapi.engines.model.fi_municipal_bonds import FIMunicipalBonds 11 | from fds.analyticsapi.engines.model.fi_municipal_bonds_for_job_settings import FIMunicipalBondsForJobSettings 12 | from fds.analyticsapi.engines.model.fi_attribution_for_securities import FIAttributionForSecurities 13 | from fds.analyticsapi.engines.model.fi_attribution_for_job_settings import FIAttributionForJobSettings 14 | 15 | import common_parameters 16 | from common_functions import CommonFunctions 17 | 18 | 19 | class TestFICalculationsApi(unittest.TestCase): 20 | def setUp(self): 21 | self.api_client = CommonFunctions.build_api_client() 22 | self.calculations_api = FICalculationsApi(self.api_client) 23 | self.run_response = self.run_calculation() 24 | self.status_response = None 25 | 26 | def run_calculation(self): 27 | calculations = ["Security Type", 28 | "Security Name", 29 | "Run Status", 30 | "Elapse Time (seconds)", 31 | "Calc From Method", 32 | "Option Pricing Model", 33 | "Yield Curve Date", 34 | "Settlement Date", 35 | "Discount Curve", 36 | "Price", 37 | "Yield to No Call", 38 | "OAS", 39 | "Effective Duration", 40 | "Effective Convexity"] 41 | 42 | securities = [ 43 | FISecurity(calc_from_method="Price", 44 | calc_from_value=100.285, 45 | symbol="912828ZG8", 46 | settlement="20201202", 47 | discount_curve="UST", 48 | face=10000.0, 49 | bank_loans=FIBankLoans(ignore_sinking_fund=True), 50 | municipal_bonds=FIMunicipalBonds(ignore_sinking_fund=True), 51 | attribution=FIAttributionForSecurities(start_price=100.00, end_price=100.3668, 52 | pricing_method="Inputted Price") 53 | ), 54 | FISecurity(calc_from_method="Price", 55 | calc_from_value=101.138, 56 | symbol="US037833AR12", 57 | settlement="20201203", 58 | discount_curve="UST", 59 | face=200000.0, 60 | bank_loans=FIBankLoans(ignore_sinking_fund=True), 61 | municipal_bonds=FIMunicipalBonds(ignore_sinking_fund=True), 62 | attribution=FIAttributionForSecurities(start_price=100.00, end_price=100.3668, 63 | pricing_method="Inputted Price") 64 | ) 65 | ] 66 | 67 | jobSettings = FIJobSettings(as_of_date="20201201", 68 | bank_loans=FIBankLoans(ignore_sinking_fund=True), 69 | municipal_bonds=FIMunicipalBondsForJobSettings(ignore_sinking_fund=True), 70 | attribution=FIAttributionForJobSettings(start_date="20210611", end_date="20210611")) 71 | 72 | fi_calculation_parameters = FICalculationParameters( 73 | securities, calculations, jobSettings) 74 | fi_calculation_parameters_root = FICalculationParametersRoot( 75 | data=fi_calculation_parameters) 76 | 77 | return self.calculations_api.post_and_calculate( 78 | fi_calculation_parameters_root=fi_calculation_parameters_root, 79 | _return_http_data_only=False 80 | ) 81 | 82 | def test_calculation_success(self): 83 | if self.run_response[1] == 202: 84 | calculation_id = self.run_response[2]["X-Factset-Api-Calculation-Id"] 85 | self.run_response = self.calculations_api.get_calculation_status_by_id( 86 | id=calculation_id, _return_http_data_only=False) 87 | while self.run_response[1] == 202: 88 | age_value = self.run_response[2].get("cache-control") 89 | if age_value is not None: 90 | max_age = age_value.replace("max-age=", "") 91 | time.sleep(int(max_age)) 92 | else: 93 | time.sleep(5) 94 | self.run_response = self.calculations_api.get_calculation_status_by_id( 95 | id=calculation_id, _return_http_data_only=False) 96 | 97 | self.assertTrue( 98 | self.run_response[1] == 200 or self.run_response[1] == 201, "Calculation should be completed") 99 | 100 | 101 | if __name__ == '__main__': 102 | unittest.main() 103 | -------------------------------------------------------------------------------- /tests/test_fiab_calculations_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import time 3 | 4 | from fds.analyticsapi.engines.api.fiab_calculations_api import FIABCalculationsApi 5 | from fds.analyticsapi.engines.model.fiab_calculation_parameters import FIABCalculationParameters 6 | from fds.analyticsapi.engines.model.fiab_identifier import FIABIdentifier 7 | from fds.analyticsapi.engines.model.fiab_date_parameters import FIABDateParameters 8 | 9 | from common_functions import CommonFunctions 10 | from api_workflow import run_api_workflow_with_assertions 11 | 12 | 13 | class TestFiabCalculationsApi(unittest.TestCase): 14 | def setUp(self): 15 | api_client = CommonFunctions.build_api_client() 16 | self.fiab_calculations_api = FIABCalculationsApi(api_client) 17 | 18 | @unittest.skip("Skip until can fix the QA user workflow") 19 | def test_single_unit_scenario(self): 20 | create_step_name = "create_calculation" 21 | read_status_step_name = "read_status" 22 | read_result_step_name = "read_result" 23 | 24 | def create_calculation(test_context): 25 | print("Creating single unit calculation") 26 | fiab_document = "Client:/aapi/AAPI_FIAB_BASE_DOC" 27 | fiab_account = FIABIdentifier( 28 | id="Client:/aapi/FIAB_TEST_HOLDINGS.ACCT") 29 | fiab_msl = "CLIENT:$$MSL_AAPI_TESTING.OFDB" 30 | fiab_dates = FIABDateParameters( 31 | startdate="20200618", enddate="20200618") 32 | 33 | fiab_calculation_parameters = FIABCalculationParameters(account=fiab_account, dates=fiab_dates, 34 | fiabdocument=fiab_document, msl=fiab_msl) 35 | 36 | post_and_calculate_response = self.fiab_calculations_api.run_calculation( 37 | fiab_calculation_parameters=fiab_calculation_parameters, _return_http_data_only=False) 38 | 39 | self.assertTrue(post_and_calculate_response[1] == 202, 40 | "Response for create_calculation should have been 202") 41 | 42 | if post_and_calculate_response[1] == 202: 43 | test_context["calculation_id"] = post_and_calculate_response[2]["x-factset-api-calculation-id"] 44 | return { 45 | "continue_workflow": True, 46 | "next_request": read_status_step_name, 47 | "test_context": test_context 48 | } 49 | 50 | def read_calculation_status(test_context): 51 | print("Reading single unit calculation status") 52 | calculation_id = test_context["calculation_id"] 53 | print("Calculation Id: " + calculation_id) 54 | 55 | status_response = self.fiab_calculations_api.get_calculation_by_id(id=calculation_id, 56 | _return_http_data_only=False) 57 | 58 | self.assertTrue(status_response[1] == 202 and ( 59 | status_response[0].status in ("Pending", "InProgress", "Done"))) 60 | 61 | while status_response[1] == 202 and (status_response[0].status in ("Pending", "InProgress")): 62 | max_age = '5' 63 | age_value = status_response[2].get("cache-control") 64 | if age_value is not None: 65 | max_age = age_value.replace("max-age=", "") 66 | print('Sleeping: ' + max_age) 67 | time.sleep(int(max_age)) 68 | status_response = self.fiab_calculations_api.get_calculation_by_id(id=calculation_id, 69 | _return_http_data_only=False) 70 | return { 71 | "continue_workflow": True, 72 | "next_request": read_result_step_name, 73 | "test_context": test_context 74 | } 75 | 76 | def read_calculation_result(test_context): 77 | calculation_id = test_context["calculation_id"] 78 | status_response = self.fiab_calculations_api.get_calculation_by_id(id=calculation_id, 79 | _return_http_data_only=False) 80 | self.assertEqual( 81 | status_response[1], 200, "Get calculation result should have succeeded") 82 | self.assertTrue(status_response[0].status == "Done", 83 | "Get calculation result should have Done status") 84 | 85 | workflow_specification = { 86 | create_step_name: create_calculation, 87 | read_status_step_name: read_calculation_status, 88 | read_result_step_name: read_calculation_result 89 | } 90 | starting_request = workflow_specification['create_calculation'] 91 | starting_test_context = {} 92 | run_api_workflow_with_assertions( 93 | workflow_specification, starting_request, starting_test_context) 94 | 95 | 96 | if __name__ == '__main__': 97 | unittest.main(failfast=True) 98 | -------------------------------------------------------------------------------- /tests/test_frequencies_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.frequencies_api import FrequenciesApi 4 | from fds.analyticsapi.engines.model.frequency import Frequency 5 | 6 | from common_functions import CommonFunctions 7 | 8 | 9 | class TestFrequenciesApi(unittest.TestCase): 10 | 11 | def setUp(self): 12 | self.frequencies_api = FrequenciesApi( 13 | CommonFunctions.build_api_client()) 14 | 15 | def test_get_pa_frequencies(self): 16 | response = self.frequencies_api.get_pa_frequencies( 17 | _return_http_data_only=False) 18 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 19 | self.assertEqual(type(response[0].data), dict, 20 | "Response should be of dictionary type.") 21 | frequencies = list(response[0].data.keys()) 22 | first_key = frequencies[0] 23 | self.assertEqual(type(response[0].data[first_key]), 24 | Frequency, "Response should be of Frequency type.") 25 | self.assertGreater(len(frequencies), 0, 26 | "Response result should not be an empty list.") 27 | 28 | def test_get_spar_frequencies(self): 29 | response = self.frequencies_api.get_spar_frequencies( 30 | _return_http_data_only=False) 31 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 32 | self.assertEqual(type(response[0].data), dict, 33 | "Response should be of dictionary type.") 34 | frequencies = list(response[0].data.keys()) 35 | first_key = frequencies[0] 36 | self.assertEqual(type(response[0].data[first_key]), 37 | Frequency, "Response should be of Frequency type.") 38 | self.assertGreater(len(frequencies), 0, 39 | "Response result should not be an empty list.") 40 | 41 | def test_get_vault_frequencies(self): 42 | response = self.frequencies_api.get_vault_frequencies( 43 | _return_http_data_only=False) 44 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 45 | self.assertEqual(type(response[0].data), dict, 46 | "Response should be of dictionary type.") 47 | frequencies = list(response[0].data.keys()) 48 | first_key = frequencies[0] 49 | self.assertEqual(type(response[0].data[first_key]), 50 | Frequency, "Response should be of Frequency type.") 51 | self.assertGreater(len(frequencies), 0, 52 | "Response result should not be an empty list.") 53 | 54 | 55 | if __name__ == '__main__': 56 | unittest.main() 57 | -------------------------------------------------------------------------------- /tests/test_groups_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.groups_api import GroupsApi 4 | from fds.analyticsapi.engines.model.group import Group 5 | from fds.analyticsapi.engines.model.frequency import Frequency 6 | 7 | from common_functions import CommonFunctions 8 | 9 | 10 | class TestGroupsApi(unittest.TestCase): 11 | 12 | def setUp(self): 13 | self.groups_api = GroupsApi(CommonFunctions.build_api_client()) 14 | 15 | def test_get_all_groups(self): 16 | response = self.groups_api.get_pa_groups(_return_http_data_only=False) 17 | group_id = list(response[0].data.keys())[0] 18 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 19 | self.assertEqual(type(response[0].data), dict, 20 | "Response should be of dictionary type") 21 | self.assertEqual( 22 | type(response[0].data[group_id]), Group, "Response should be of Group type") 23 | 24 | def test_get_pa_grouping_frequencies(self): 25 | response = self.groups_api.get_pa_grouping_frequencies(_return_http_data_only=False) 26 | group_frequency_id = list(response[0].data.keys())[0] 27 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 28 | self.assertEqual(type(response[0].data), dict, 29 | "Response should be of dictionary type") 30 | self.assertEqual( 31 | type(response[0].data[group_frequency_id]), Frequency, "Response should be of Frequency type") 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /tests/test_pricing_sources_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.pricing_sources_api import PricingSourcesApi 4 | 5 | from common_functions import CommonFunctions 6 | 7 | 8 | class TestPricingSourcesApi(unittest.TestCase): 9 | 10 | def setUp(self): 11 | self.pricing_sources_api = PricingSourcesApi(CommonFunctions.build_api_client()) 12 | 13 | def test_pricing_sources(self): 14 | response = self.pricing_sources_api.get_pa_pricing_sources(_return_http_data_only=False) 15 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 16 | self.assertEqual(type(response[0].data), dict, 17 | "Response should be of dictionary type") 18 | 19 | 20 | if __name__ == '__main__': 21 | unittest.main() 22 | -------------------------------------------------------------------------------- /tests/test_spar_benchmark_api.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | from fds.analyticsapi.engines.api.benchmarks_api import BenchmarksApi 4 | from fds.analyticsapi.engines.model.spar_benchmark_root import SPARBenchmarkRoot 5 | 6 | import common_parameters 7 | from common_functions import CommonFunctions 8 | 9 | 10 | class TestSparBenchmarkApi(unittest.TestCase): 11 | 12 | def setUp(self): 13 | self.spar_benchmark_api = BenchmarksApi( 14 | CommonFunctions.build_api_client()) 15 | 16 | def test_get_spar_benchmark_by_id(self): 17 | response = self.spar_benchmark_api.get_spar_benchmark_by_id(common_parameters.spar_benchmark_r1000, 18 | _return_http_data_only=False 19 | ) 20 | self.assertEqual(response[1], 200, "Response should be 200 - Success") 21 | self.assertEqual( 22 | type(response[0]), SPARBenchmarkRoot, "Response should be of SPARBenchmark type") 23 | 24 | 25 | if __name__ == '__main__': 26 | unittest.main() 27 | -------------------------------------------------------------------------------- /tests/tests.pyproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | Debug 4 | 2.0 5 | 102bf607-1630-4c9f-85d2-ad0dbb8a3854 6 | . 7 | test_accounts_api.py 8 | 9 | 10 | . 11 | . 12 | tests 13 | tests 14 | Standard Python launcher 15 | False 16 | False 17 | Global|PythonCore|3.7 18 | 19 | 20 | true 21 | false 22 | 23 | 24 | true 25 | false 26 | 27 | 28 | 29 | Code 30 | 31 | 32 | Code 33 | 34 | 35 | Code 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 58 | 59 | 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /tests/tests.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.28307.572 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{888888A0-9F3D-457C-B088-3A5042F75D52}") = "tests", "tests.pyproj", "{102BF607-1630-4C9F-85D2-AD0DBB8A3854}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {102BF607-1630-4C9F-85D2-AD0DBB8A3854}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {102BF607-1630-4C9F-85D2-AD0DBB8A3854}.Release|Any CPU.ActiveCfg = Release|Any CPU 16 | EndGlobalSection 17 | GlobalSection(SolutionProperties) = preSolution 18 | HideSolutionNode = FALSE 19 | EndGlobalSection 20 | GlobalSection(ExtensibilityGlobals) = postSolution 21 | SolutionGuid = {A3580043-E511-4FAB-B03C-2F0488B7DB88} 22 | EndGlobalSection 23 | EndGlobal 24 | --------------------------------------------------------------------------------