feat(sdk): Auto-created from 'analyticsapi-engines-sdk-generator' repository PR 52 for SDK version v5.6.0

auto-generated-sdk/.openapi-generator/FILES

@@ -68,10 +68,12 @@ docs/FIABCalculationStatusSummary.md
 docs/FIABCalculationsApi.md
 docs/FIABDateParameters.md
 docs/FIABIdentifier.md
+docs/FIBalloonExtension.md
 docs/FIBankLoans.md
 docs/FICalculationParameters.md
 docs/FICalculationParametersRoot.md
 docs/FICalculationsApi.md
+docs/FICashflows.md
 docs/FIDiscountCurveInfo.md
 docs/FIDiscountCurveInfoRoot.md
 docs/FIJobSettings.md
@@ -80,9 +82,14 @@ docs/FIMarketEnvironment.md
 docs/FIMunicipalBonds.md
 docs/FIMunicipalBondsForJobSettings.md
 docs/FIPrepay.md
+docs/FIPrepayLockout.md
 docs/FIReferencePrepay.md
 docs/FIReferenceSecurity.md
 docs/FISecurity.md
+docs/FIServicerAdvances.md
+docs/FIServicerAdvancesForSecurities.md
+docs/FIStructuredProductsForJobSettings.md
+docs/FIStructuredProductsForSecurities.md
 docs/FPOAccount.md
 docs/FPOObjective.md
 docs/FPOOptimizationParameters.md
@@ -302,9 +309,11 @@ fds/analyticsapi/engines/model/document_directories_root.py
 fds/analyticsapi/engines/model/error.py
 fds/analyticsapi/engines/model/error_source.py
 fds/analyticsapi/engines/model/event_summary.py
+fds/analyticsapi/engines/model/fi_balloon_extension.py
 fds/analyticsapi/engines/model/fi_bank_loans.py
 fds/analyticsapi/engines/model/fi_calculation_parameters.py
 fds/analyticsapi/engines/model/fi_calculation_parameters_root.py
+fds/analyticsapi/engines/model/fi_cashflows.py
 fds/analyticsapi/engines/model/fi_discount_curve_info.py
 fds/analyticsapi/engines/model/fi_discount_curve_info_root.py
 fds/analyticsapi/engines/model/fi_job_settings.py
@@ -313,9 +322,14 @@ fds/analyticsapi/engines/model/fi_market_environment.py
 fds/analyticsapi/engines/model/fi_municipal_bonds.py
 fds/analyticsapi/engines/model/fi_municipal_bonds_for_job_settings.py
 fds/analyticsapi/engines/model/fi_prepay.py
+fds/analyticsapi/engines/model/fi_prepay_lockout.py
 fds/analyticsapi/engines/model/fi_reference_prepay.py
 fds/analyticsapi/engines/model/fi_reference_security.py
 fds/analyticsapi/engines/model/fi_security.py
+fds/analyticsapi/engines/model/fi_servicer_advances.py
+fds/analyticsapi/engines/model/fi_servicer_advances_for_securities.py
+fds/analyticsapi/engines/model/fi_structured_products_for_job_settings.py
+fds/analyticsapi/engines/model/fi_structured_products_for_securities.py
 fds/analyticsapi/engines/model/fiab_calculation_parameters.py
 fds/analyticsapi/engines/model/fiab_calculation_status.py
 fds/analyticsapi/engines/model/fiab_calculation_status_summary.py

auto-generated-sdk/README.md

@@ -4,7 +4,7 @@ Allow clients to fetch Analytics through APIs.
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
-- Package version: 5.5.0
+- Package version: 5.6.0
 - Build package: CustomPythonClientCodegen
 For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
 
@@ -276,9 +276,11 @@ Class | Method | HTTP request | Description
  - [FIABCalculationStatusSummary](docs/FIABCalculationStatusSummary.md)
  - [FIABDateParameters](docs/FIABDateParameters.md)
  - [FIABIdentifier](docs/FIABIdentifier.md)
+ - [FIBalloonExtension](docs/FIBalloonExtension.md)
  - [FIBankLoans](docs/FIBankLoans.md)
  - [FICalculationParameters](docs/FICalculationParameters.md)
  - [FICalculationParametersRoot](docs/FICalculationParametersRoot.md)
+ - [FICashflows](docs/FICashflows.md)
  - [FIDiscountCurveInfo](docs/FIDiscountCurveInfo.md)
  - [FIDiscountCurveInfoRoot](docs/FIDiscountCurveInfoRoot.md)
  - [FIJobSettings](docs/FIJobSettings.md)
@@ -287,9 +289,14 @@ Class | Method | HTTP request | Description
  - [FIMunicipalBonds](docs/FIMunicipalBonds.md)
  - [FIMunicipalBondsForJobSettings](docs/FIMunicipalBondsForJobSettings.md)
  - [FIPrepay](docs/FIPrepay.md)
+ - [FIPrepayLockout](docs/FIPrepayLockout.md)
  - [FIReferencePrepay](docs/FIReferencePrepay.md)
  - [FIReferenceSecurity](docs/FIReferenceSecurity.md)
  - [FISecurity](docs/FISecurity.md)
+ - [FIServicerAdvances](docs/FIServicerAdvances.md)
+ - [FIServicerAdvancesForSecurities](docs/FIServicerAdvancesForSecurities.md)
+ - [FIStructuredProductsForJobSettings](docs/FIStructuredProductsForJobSettings.md)
+ - [FIStructuredProductsForSecurities](docs/FIStructuredProductsForSecurities.md)
  - [FPOAccount](docs/FPOAccount.md)
  - [FPOObjective](docs/FPOObjective.md)
  - [FPOOptimizationParameters](docs/FPOOptimizationParameters.md)
@@ -428,7 +435,7 @@ Class | Method | HTTP request | Description
 
 ## Author
 
-analytics.api.support@factset.com
+api@factset.com
 
 
 ## Notes for Large OpenAPI documents

auto-generated-sdk/docs/FIBalloonExtension.md

@@ -0,0 +1,15 @@
+# FIBalloonExtension
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**months** | **int** | Months | [optional] 
+**percentage** | **float** | Percentage | [optional] 
+**amortization_type** | **str** | Amortization Type | [optional] 
+**units** | **str** | Units | [optional] 
+**coupon_stepup** | **float** | Coupon Stepup | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

auto-generated-sdk/docs/FICalculationsApi.md

@@ -451,6 +451,32 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
                     ),
                     matrix_spread_adjustment=3.14,
                     matrix_multiplier=3.14,
+                    structured_products=FIStructuredProductsForSecurities(
+                        servicer_advances=FIServicerAdvancesForSecurities(
+                            principal=3.14,
+                            interest=3.14,
+                            advance_type="Advances All",
+                        ),
+                        ignore_financial_guarantee="ignore_financial_guarantee_example",
+                        clean_up_call_method=True,
+                        do_opt_redeem="do_opt_redeem_example",
+                        prepay_lockout=FIPrepayLockout(
+                            points_above="ANY",
+                            ym_above="ANY",
+                        ),
+                        cashflows=FICashflows(
+                            optional_redemption_call_when_units="Manual",
+                            optional_redemption_call_when=1,
+                            recovery_lag=1,
+                        ),
+                        balloon_extension=FIBalloonExtension(
+                            months=1,
+                            percentage=3.14,
+                            amortization_type="Loan_Amort_None",
+                            units="units_example",
+                            coupon_stepup=3.14,
+                        ),
+                    ),
                     calc_from_method="calc_from_method_example",
                     calc_from_value=3.14,
                     face=1,
@@ -481,6 +507,30 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
                 market_environment=FIMarketEnvironment(
                     rate_path="FLAT & FORWARD",
                 ),
+                structured_products=FIStructuredProductsForJobSettings(
+                    servicer_advances=FIServicerAdvances(
+                        advance_type="Advances All",
+                    ),
+                    ignore_financial_guarantee="ignore_financial_guarantee_example",
+                    clean_up_call_method=True,
+                    do_opt_redeem="do_opt_redeem_example",
+                    prepay_lockout=FIPrepayLockout(
+                        points_above="ANY",
+                        ym_above="ANY",
+                    ),
+                    cashflows=FICashflows(
+                        optional_redemption_call_when_units="Manual",
+                        optional_redemption_call_when=1,
+                        recovery_lag=1,
+                    ),
+                    balloon_extension=FIBalloonExtension(
+                        months=1,
+                        percentage=3.14,
+                        amortization_type="Loan_Amort_None",
+                        units="units_example",
+                        coupon_stepup=3.14,
+                    ),
+                ),
             ),
         ),
         meta=CalculationMeta(
@@ -621,6 +671,32 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
                     ),
                     matrix_spread_adjustment=3.14,
                     matrix_multiplier=3.14,
+                    structured_products=FIStructuredProductsForSecurities(
+                        servicer_advances=FIServicerAdvancesForSecurities(
+                            principal=3.14,
+                            interest=3.14,
+                            advance_type="Advances All",
+                        ),
+                        ignore_financial_guarantee="ignore_financial_guarantee_example",
+                        clean_up_call_method=True,
+                        do_opt_redeem="do_opt_redeem_example",
+                        prepay_lockout=FIPrepayLockout(
+                            points_above="ANY",
+                            ym_above="ANY",
+                        ),
+                        cashflows=FICashflows(
+                            optional_redemption_call_when_units="Manual",
+                            optional_redemption_call_when=1,
+                            recovery_lag=1,
+                        ),
+                        balloon_extension=FIBalloonExtension(
+                            months=1,
+                            percentage=3.14,
+                            amortization_type="Loan_Amort_None",
+                            units="units_example",
+                            coupon_stepup=3.14,
+                        ),
+                    ),
                     calc_from_method="calc_from_method_example",
                     calc_from_value=3.14,
                     face=1,
@@ -651,6 +727,30 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
                 market_environment=FIMarketEnvironment(
                     rate_path="FLAT & FORWARD",
                 ),
+                structured_products=FIStructuredProductsForJobSettings(
+                    servicer_advances=FIServicerAdvances(
+                        advance_type="Advances All",
+                    ),
+                    ignore_financial_guarantee="ignore_financial_guarantee_example",
+                    clean_up_call_method=True,
+                    do_opt_redeem="do_opt_redeem_example",
+                    prepay_lockout=FIPrepayLockout(
+                        points_above="ANY",
+                        ym_above="ANY",
+                    ),
+                    cashflows=FICashflows(
+                        optional_redemption_call_when_units="Manual",
+                        optional_redemption_call_when=1,
+                        recovery_lag=1,
+                    ),
+                    balloon_extension=FIBalloonExtension(
+                        months=1,
+                        percentage=3.14,
+                        amortization_type="Loan_Amort_None",
+                        units="units_example",
+                        coupon_stepup=3.14,
+                    ),
+                ),
             ),
         ),
         meta=CalculationMeta(

auto-generated-sdk/docs/FICashflows.md

@@ -0,0 +1,13 @@
+# FICashflows
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**optional_redemption_call_when_units** | **str** | OptionalRedemptionCallWhenUnits | [optional] 
+**optional_redemption_call_when** | **int** | OptionalRedemptionCallWhen | [optional] 
+**recovery_lag** | **int** | RecoveryLag | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

auto-generated-sdk/docs/FIJobSettings.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **bank_loans** | [**FIBankLoans**](FIBankLoans.md) |  | [optional] 
 **municipal_bonds** | [**FIMunicipalBondsForJobSettings**](FIMunicipalBondsForJobSettings.md) |  | [optional] 
 **market_environment** | [**FIMarketEnvironment**](FIMarketEnvironment.md) |  | [optional] 
+**structured_products** | [**FIStructuredProductsForJobSettings**](FIStructuredProductsForJobSettings.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

auto-generated-sdk/docs/FIPrepayLockout.md

@@ -0,0 +1,12 @@
+# FIPrepayLockout
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**points_above** | **str** | Points Above | [optional] 
+**ym_above** | **str** | Ym Above | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

auto-generated-sdk/docs/FISecurity.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **prepay** | [**FIPrepay**](FIPrepay.md) |  | [optional] 
 **matrix_spread_adjustment** | **float** | Matrix Spread Adjustment | [optional] 
 **matrix_multiplier** | **float** | Matrix Multiplier | [optional] 
+**structured_products** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) |  | [optional] 
 **calc_from_method** | **str** | Calculation Method.  Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield,  Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix | [optional] 
 **face** | **float** | Face | [optional]  if omitted the server will use the default value of 1
 **face_type** | **str** | Face type | [optional]  if omitted the server will use the default value of "Current"

auto-generated-sdk/docs/FIServicerAdvances.md

@@ -0,0 +1,11 @@
+# FIServicerAdvances
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**advance_type** | **str** | Advance Type | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

auto-generated-sdk/docs/FIServicerAdvancesForSecurities.md

@@ -0,0 +1,13 @@
+# FIServicerAdvancesForSecurities
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**principal** | **float** | Principal | [optional] 
+**interest** | **float** | Interest | [optional] 
+**advance_type** | **str** | Advance Type | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

auto-generated-sdk/docs/FIStructuredProductsForJobSettings.md

@@ -0,0 +1,17 @@
+# FIStructuredProductsForJobSettings
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**servicer_advances** | [**FIServicerAdvances**](FIServicerAdvances.md) |  | [optional] 
+**ignore_financial_guarantee** | **str** | Ignore Financial Guarantee | [optional] 
+**clean_up_call_method** | **bool** | Cleanup Call Method | [optional] 
+**do_opt_redeem** | **str** | Do OPT Redeem | [optional] 
+**prepay_lockout** | [**FIPrepayLockout**](FIPrepayLockout.md) |  | [optional] 
+**cashflows** | [**FICashflows**](FICashflows.md) |  | [optional] 
+**balloon_extension** | [**FIBalloonExtension**](FIBalloonExtension.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

auto-generated-sdk/docs/FIStructuredProductsForSecurities.md

@@ -0,0 +1,17 @@
+# FIStructuredProductsForSecurities
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**servicer_advances** | [**FIServicerAdvancesForSecurities**](FIServicerAdvancesForSecurities.md) |  | [optional] 
+**ignore_financial_guarantee** | **str** | Ignore Financial Guarantee | [optional] 
+**clean_up_call_method** | **bool** | Cleanup Call Method | [optional] 
+**do_opt_redeem** | **str** | Do OPT Redeem | [optional] 
+**prepay_lockout** | [**FIPrepayLockout**](FIPrepayLockout.md) |  | [optional] 
+**cashflows** | [**FICashflows**](FICashflows.md) |  | [optional] 
+**balloon_extension** | [**FIBalloonExtension**](FIBalloonExtension.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+