lusid-sdk 2.1.911__py3-none-any.whl → 2.1.913__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +126 -126
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_holding.py +6 -2
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +6 -4
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/settlement_schedule.py +20 -2
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/transaction_settlement_instruction.py +5 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/RECORD +333 -333
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/WHEEL +0 -0
@@ -25,13 +25,13 @@ from lusid.models.schedule import Schedule
|
|
25
25
|
|
26
26
|
class BondConversionSchedule(Schedule):
|
27
27
|
"""
|
28
|
-
A BondConversionSchedule object represents a class containing the
|
28
|
+
A BondConversionSchedule object represents a class containing the information required for the creation of convertible features in a ComplexBond # noqa: E501
|
29
29
|
"""
|
30
|
-
identifiers: Optional[Dict[str, StrictStr]] = Field(None, description="The market identifier(s) of the share that the bond converts to. The instrument
|
30
|
+
identifiers: Optional[Dict[str, StrictStr]] = Field(None, description="The market identifier(s) of the share that the bond converts to. The instrument will not fail validation if no identifier is supplied.")
|
31
31
|
bond_conversion_entries: Optional[conlist(BondConversionEntry)] = Field(None, alias="bondConversionEntries", description="The dates at which the bond may be converted and associated information required about the conversion.")
|
32
|
-
conversion_trigger: StrictStr = Field(...,alias="conversionTrigger", description="Corporate event that triggers a conversion
|
33
|
-
delivery_type: Optional[StrictStr] = Field(None,alias="deliveryType", description="Is a conversion made into cash or into shares?
|
34
|
-
exercise_type: StrictStr = Field(...,alias="exerciseType", description="The exercise type of the conversion schedule (American or European).
|
32
|
+
conversion_trigger: StrictStr = Field(...,alias="conversionTrigger", description="Corporate event that triggers a conversion Supported string (enumeration) values are: [NextEquityFinancing, IpoConversion, KnownDates, SoftCall].")
|
33
|
+
delivery_type: Optional[StrictStr] = Field(None,alias="deliveryType", description="Is a conversion made into cash or into shares? Supported string (enumeration) values are: [Cash, Physical].")
|
34
|
+
exercise_type: StrictStr = Field(...,alias="exerciseType", description="The exercise type of the conversion schedule (American or European). For American type, the bond is convertible from a given exercise date until the next date in the schedule, or until it matures. For European type, the bond is only convertible on the given exercise date. Supported string (enumeration) values are: [European, Bermudan, American].")
|
35
35
|
includes_accrued: Optional[StrictBool] = Field(None, alias="includesAccrued", description="Set this to true if a accrued interest is included in the conversion. Defaults to true.")
|
36
36
|
mandatory_conversion: Optional[StrictBool] = Field(None, alias="mandatoryConversion", description="Set this to true if a conversion is mandatory if the trigger occurs. Defaults to false.")
|
37
37
|
notification_period_end: Optional[datetime] = Field(None, alias="notificationPeriodEnd", description="The last day in the notification period for the conversion of the bond")
|
@@ -24,7 +24,7 @@ from lusid.models.instrument_event import InstrumentEvent
|
|
24
24
|
|
25
25
|
class BondCouponEvent(InstrumentEvent):
|
26
26
|
"""
|
27
|
-
Definition of a Bond Coupon Event
|
27
|
+
Definition of a Bond Coupon Event This is an event that describes the occurence of a cashflow due to a fixed rate bond coupon payment. # noqa: E501
|
28
28
|
"""
|
29
29
|
ex_date: Optional[datetime] = Field(None, alias="exDate", description="Ex-Dividend date of the coupon payment")
|
30
30
|
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Payment date of the coupon payment")
|
@@ -24,7 +24,7 @@ from lusid.models.instrument_event import InstrumentEvent
|
|
24
24
|
|
25
25
|
class BondPrincipalEvent(InstrumentEvent):
|
26
26
|
"""
|
27
|
-
Definition of a Bond Principal Event
|
27
|
+
Definition of a Bond Principal Event This is an event that describes the occurence of a cashflow due to the principal payment. # noqa: E501
|
28
28
|
"""
|
29
29
|
currency: StrictStr = Field(...,alias="currency", description="Currency of the principal payment")
|
30
30
|
ex_date: Optional[datetime] = Field(None, alias="exDate", description="Ex-Dividend date of the principal payment")
|
@@ -29,10 +29,10 @@ class BucketedCashFlowResponse(BaseModel):
|
|
29
29
|
BucketedCashFlowResponse
|
30
30
|
"""
|
31
31
|
href: Optional[StrictStr] = Field(None,alias="href")
|
32
|
-
data: Optional[conlist(Dict[str, Any])] = Field(None, description="List of dictionary bucketed cash flow result set.
|
33
|
-
report_currency: Optional[StrictStr] = Field(None,alias="reportCurrency", description="Three letter ISO currency string indicating what currency to report in for ReportCcy denominated queries.
|
32
|
+
data: Optional[conlist(Dict[str, Any])] = Field(None, description="List of dictionary bucketed cash flow result set. Each dictionary represent a bucketed cashflow result set keyed by AddressKeys. e.g. dictionary[\"Valuation/CashFlowAmount\"] for the aggregated cash flow amount for the bucket. e.g. suppose \"RoundUp\" method, then dictionary[\"Valuation/CashFlowDate/RoundUp\"] returns the bucketed cashflow date.")
|
33
|
+
report_currency: Optional[StrictStr] = Field(None,alias="reportCurrency", description="Three letter ISO currency string indicating what currency to report in for ReportCcy denominated queries. If not present then the currency of the relevant portfolio will be used in its place where relevant.")
|
34
34
|
data_schema: Optional[ResultDataSchema] = Field(None, alias="dataSchema")
|
35
|
-
failed: Optional[Dict[str, ErrorDetail]] = Field(None, description="Information about where instruments have failed to return cashflows in so far as it is available.
|
35
|
+
failed: Optional[Dict[str, ErrorDetail]] = Field(None, description="Information about where instruments have failed to return cashflows in so far as it is available. e.g., failure to retrieve a market quote for a floating rate instrument.")
|
36
36
|
links: Optional[conlist(Link)] = None
|
37
37
|
__properties = ["href", "data", "reportCurrency", "dataSchema", "failed", "links"]
|
38
38
|
|
@@ -25,7 +25,7 @@ from lusid.models.resource_id import ResourceId
|
|
25
25
|
|
26
26
|
class CancelSingleHoldingAdjustmentRequest(BaseModel):
|
27
27
|
"""
|
28
|
-
This request specifies single target holding. i.e. holding data that the
|
28
|
+
This request specifies single target holding. i.e. holding data that the system should match. And deletes previous adjustment made to that holding # noqa: E501
|
29
29
|
"""
|
30
30
|
instrument_identifiers: Dict[str, StrictStr] = Field(..., alias="instrumentIdentifiers", description="A set of instrument identifiers that can resolve the holding adjustment to a unique instrument.")
|
31
31
|
sub_holding_keys: Optional[Dict[str, PerpetualProperty]] = Field(None, alias="subHoldingKeys", description="The sub-holding properties which identify the holding. Each property must be from the 'Transaction' domain.")
|
lusid/models/cap_floor.py
CHANGED
@@ -29,12 +29,12 @@ class CapFloor(LusidInstrument):
|
|
29
29
|
"""
|
30
30
|
LUSID representation of Cap, Floor, or Collar. # noqa: E501
|
31
31
|
"""
|
32
|
-
cap_floor_type: StrictStr = Field(...,alias="capFloorType", description="Determine if it's CAP, FLOOR, or COLLAR.
|
32
|
+
cap_floor_type: StrictStr = Field(...,alias="capFloorType", description="Determine if it's CAP, FLOOR, or COLLAR. Supported string (enumeration) values are: [Cap, Floor, Collar].")
|
33
33
|
cap_strike: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="capStrike", description="Strike rate of the Cap.")
|
34
34
|
floor_strike: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="floorStrike", description="Strike rate of the Floor.")
|
35
35
|
include_first_caplet: StrictBool = Field(..., alias="includeFirstCaplet", description="Include first caplet flag.")
|
36
36
|
underlying_floating_leg: FloatingLeg = Field(..., alias="underlyingFloatingLeg")
|
37
|
-
additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven equity swap.
|
37
|
+
additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven equity swap. The dates must be distinct and either all payments are Pay or all payments are Receive.")
|
38
38
|
time_zone_conventions: Optional[TimeZoneConventions] = Field(None, alias="timeZoneConventions")
|
39
39
|
instrument_type: StrictStr = Field(...,alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo")
|
40
40
|
additional_properties: Dict[str, Any] = {}
|
@@ -31,7 +31,7 @@ class CashAndSecurityOfferElection(BaseModel):
|
|
31
31
|
cost_factor: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="costFactor", description="Optional. The fraction of cost that is transferred from the existing shares to the new shares.")
|
32
32
|
election_key: StrictStr = Field(...,alias="electionKey", description="Unique key associated to this election.")
|
33
33
|
is_chosen: Optional[StrictBool] = Field(None, alias="isChosen", description="Is this the election that has been explicitly chosen from multiple options.")
|
34
|
-
is_default: Optional[StrictBool] = Field(None, alias="isDefault", description="Is this election automatically applied in the absence of an election having been made.
|
34
|
+
is_default: Optional[StrictBool] = Field(None, alias="isDefault", description="Is this election automatically applied in the absence of an election having been made. May only be true for one election if multiple are provided.")
|
35
35
|
units_ratio: UnitsRatio = Field(..., alias="unitsRatio")
|
36
36
|
__properties = ["cashOfferCurrency", "cashOfferPrice", "costFactor", "electionKey", "isChosen", "isDefault", "unitsRatio"]
|
37
37
|
|
lusid/models/cash_dependency.py
CHANGED
@@ -24,10 +24,10 @@ from lusid.models.economic_dependency import EconomicDependency
|
|
24
24
|
|
25
25
|
class CashDependency(EconomicDependency):
|
26
26
|
"""
|
27
|
-
For indicating a dependency upon a currency.
|
27
|
+
For indicating a dependency upon a currency. E.g. A Bond will declare a CashDependency for its domestic currency. # noqa: E501
|
28
28
|
"""
|
29
29
|
currency: StrictStr = Field(...,alias="currency", description="The Currency that is depended upon.")
|
30
|
-
var_date: datetime = Field(..., alias="date", description="The effectiveDate of the entity that this is a dependency for.
|
30
|
+
var_date: datetime = Field(..., alias="date", description="The effectiveDate of the entity that this is a dependency for. Unless there is an obvious date this should be, like for a historic reset, then this is the valuation date.")
|
31
31
|
dependency_type: StrictStr = Field(...,alias="dependencyType", description="The available values are: OpaqueDependency, CashDependency, DiscountingDependency, EquityCurveDependency, EquityVolDependency, FxDependency, FxForwardsDependency, FxVolDependency, IndexProjectionDependency, IrVolDependency, QuoteDependency, Vendor, CalendarDependency, InflationFixingDependency")
|
32
32
|
additional_properties: Dict[str, Any] = {}
|
33
33
|
__properties = ["dependencyType", "currency", "date"]
|
lusid/models/cash_flow_event.py
CHANGED
@@ -25,7 +25,7 @@ from lusid.models.instrument_event import InstrumentEvent
|
|
25
25
|
|
26
26
|
class CashFlowEvent(InstrumentEvent):
|
27
27
|
"""
|
28
|
-
Definition of a CashFlow event.
|
28
|
+
Definition of a CashFlow event. This is an event that describes the occurence of a cashflow and associated information. # noqa: E501
|
29
29
|
"""
|
30
30
|
cash_flow_value: CashFlowValue = Field(..., alias="cashFlowValue")
|
31
31
|
event_type: StrictStr = Field(...,alias="eventType", description="What type of internal event does this represent; coupon, principal, premium etc.")
|
@@ -25,8 +25,8 @@ class CashFlowLineage(BaseModel):
|
|
25
25
|
"""
|
26
26
|
Lineage for cash flow value # noqa: E501
|
27
27
|
"""
|
28
|
-
instrument_type: Optional[StrictStr] = Field(None,alias="instrumentType", description="The instrument type of the instrument to which the cash flow belongs to. When upserting CashFlowValues, this
|
29
|
-
cash_flow_type: Optional[StrictStr] = Field(None,alias="cashFlowType", description="The cashflow type.When upserting CashFlowValues, this should be null, or one of [Unknown, Coupon, Notional,
|
28
|
+
instrument_type: Optional[StrictStr] = Field(None,alias="instrumentType", description="The instrument type of the instrument to which the cash flow belongs to. When upserting CashFlowValues, this should be null.")
|
29
|
+
cash_flow_type: Optional[StrictStr] = Field(None,alias="cashFlowType", description="The cashflow type.When upserting CashFlowValues, this should be null, or one of [Unknown, Coupon, Notional, Premium, Principal, Protection, Cash]")
|
30
30
|
instrument_id: Optional[StrictStr] = Field(None,alias="instrumentId", description="The LUID of the instrument to which the cash flow belongs to. When upserting this should be null.")
|
31
31
|
leg_id: Optional[StrictStr] = Field(None,alias="legId", description="The leg id to which the cash flow belongs to.")
|
32
32
|
source_transaction_id: Optional[StrictStr] = Field(None,alias="sourceTransactionId", description="The source transaction of the instrument to which the cash flow belongs to. When upserting this should be null")
|
@@ -29,7 +29,7 @@ class CashOfferElection(BaseModel):
|
|
29
29
|
cash_offer_price: Union[StrictFloat, StrictInt] = Field(..., alias="cashOfferPrice", description="Price per share of the cash offer")
|
30
30
|
election_key: StrictStr = Field(...,alias="electionKey", description="Unique key associated to this election.")
|
31
31
|
is_chosen: Optional[StrictBool] = Field(None, alias="isChosen", description="Is this the election that has been explicitly chosen from multiple options.")
|
32
|
-
is_default: Optional[StrictBool] = Field(None, alias="isDefault", description="Is this election automatically applied in the absence of an election having been made.
|
32
|
+
is_default: Optional[StrictBool] = Field(None, alias="isDefault", description="Is this election automatically applied in the absence of an election having been made. May only be true for one election if multiple are provided.")
|
33
33
|
__properties = ["cashOfferCurrency", "cashOfferPrice", "electionKey", "isChosen", "isDefault"]
|
34
34
|
|
35
35
|
class Config:
|
@@ -25,16 +25,16 @@ class CdsFlowConventions(BaseModel):
|
|
25
25
|
"""
|
26
26
|
CdsFlowConventions
|
27
27
|
"""
|
28
|
-
roll_frequency: Optional[StrictStr] = Field(None,alias="rollFrequency", description="The frequency at which the reference bonds are updated, this defaults to 6M, but can be 3M, exp for historically issued products.
|
28
|
+
roll_frequency: Optional[StrictStr] = Field(None,alias="rollFrequency", description="The frequency at which the reference bonds are updated, this defaults to 6M, but can be 3M, exp for historically issued products. For more information on tenors, see [knowledge base article KA-02097](https://support.lusid.com/knowledgebase/article/KA-02097)")
|
29
29
|
currency: StrictStr = Field(...,alias="currency", description="Currency of the flow convention.")
|
30
|
-
payment_frequency: StrictStr = Field(...,alias="paymentFrequency", description="When generating a multiperiod flow, or when the maturity of the flow is not given but the start date is,
|
31
|
-
day_count_convention: StrictStr = Field(...,alias="dayCountConvention", description="when calculating the fraction of a year between two dates, what convention is used to represent the number of days in a year
|
32
|
-
roll_convention: StrictStr = Field(...,alias="rollConvention", description="For backward compatibility, this can either specify a business day convention or a roll convention. If the business
|
30
|
+
payment_frequency: StrictStr = Field(...,alias="paymentFrequency", description="When generating a multiperiod flow, or when the maturity of the flow is not given but the start date is, the tenor is the time-step from the anchor-date to the nominal maturity of the flow prior to any adjustment.")
|
31
|
+
day_count_convention: StrictStr = Field(...,alias="dayCountConvention", description="when calculating the fraction of a year between two dates, what convention is used to represent the number of days in a year and difference between them. For more information on day counts, see [knowledge base article KA-01798](https://support.lusid.com/knowledgebase/article/KA-01798) Supported string (enumeration) values are: [Actual360, Act360, MoneyMarket, Actual365, Act365, Thirty360, ThirtyU360, Bond, ThirtyE360, EuroBond, ActualActual, ActAct, ActActIsda, ActActIsma, ActActIcma, OneOne, Act364, Act365F, Act365L, Act365_25, Act252, Bus252, NL360, NL365, ActActAFB, Act365Cad, ThirtyActIsda, Thirty365Isda, ThirtyEActIsda, ThirtyE360Isda, ThirtyE365Isda, ThirtyU360EOM].")
|
32
|
+
roll_convention: StrictStr = Field(...,alias="rollConvention", description="For backward compatibility, this can either specify a business day convention or a roll convention. If the business day convention is provided using the BusinessDayConvention property, this must be a valid roll convention. When used as a roll convention: The conventions specifying the rule used to generate dates in a schedule. Supported string (enumeration) values are: [None, EndOfMonth, IMM, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, FirstMonday, FirstTuesday, FirstWednesday, FirstThursday, FirstFriday, SecondMonday, SecondTuesday, SecondWednesday, SecondThursday, SecondFriday, ThirdMonday, ThirdTuesday, ThirdWednesday, ThirdThursday, ThirdFriday, FourthMonday, FourthTuesday, FourthWednesday, FourthThursday, FourthFriday, LastMonday, LastTuesday, LastWednesday, LastThursday, LastFriday]. When in backward compatible mode: Supported string (enumeration) values are: [NoAdjustment, None, Previous, P, Following, F, ModifiedPrevious, MP, ModifiedFollowing, MF, HalfMonthModifiedFollowing].")
|
33
33
|
payment_calendars: conlist(StrictStr) = Field(..., alias="paymentCalendars", description="An array of strings denoting holiday calendars that apply to generation of payment schedules.")
|
34
34
|
reset_calendars: conlist(StrictStr) = Field(..., alias="resetCalendars", description="An array of strings denoting holiday calendars that apply to generation of reset schedules.")
|
35
35
|
settle_days: Optional[StrictInt] = Field(None, alias="settleDays", description="Number of Good Business Days between the trade date and the effective or settlement date of the instrument. Defaults to 0 if not set.")
|
36
36
|
reset_days: Optional[StrictInt] = Field(None, alias="resetDays", description="The number of Good Business Days between determination and payment of reset. Defaults to 0 if not set.")
|
37
|
-
business_day_convention: Optional[StrictStr] = Field(None,alias="businessDayConvention", description="When generating a set of dates, what convention should be used for adjusting dates that coincide with a non-business day.
|
37
|
+
business_day_convention: Optional[StrictStr] = Field(None,alias="businessDayConvention", description="When generating a set of dates, what convention should be used for adjusting dates that coincide with a non-business day. Supported string (enumeration) values are: [NoAdjustment, None, Previous, P, Following, F, ModifiedPrevious, MP, ModifiedFollowing, MF, HalfMonthModifiedFollowing, Nearest].")
|
38
38
|
scope: Optional[StrictStr] = Field(None,alias="scope", description="The scope used when updating or inserting the convention.")
|
39
39
|
code: Optional[StrictStr] = Field(None,alias="code", description="The code of the convention.")
|
40
40
|
__properties = ["rollFrequency", "currency", "paymentFrequency", "dayCountConvention", "rollConvention", "paymentCalendars", "resetCalendars", "settleDays", "resetDays", "businessDayConvention", "scope", "code"]
|
lusid/models/cds_index.py
CHANGED
@@ -29,17 +29,17 @@ from lusid.models.time_zone_conventions import TimeZoneConventions
|
|
29
29
|
|
30
30
|
class CdsIndex(LusidInstrument):
|
31
31
|
"""
|
32
|
-
LUSID representation of a Credit Default Swap Index (CDX).
|
32
|
+
LUSID representation of a Credit Default Swap Index (CDX). This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252). | Leg Index | Leg Identifier | Description | | --------- | -------------- | ----------- | | 1 | ProtectionLeg | Payments made by the protection seller in the case of default across all CDS instruments in the index. | | 2 | PremiumLeg | The premium payments made by the protection buyer across all CDS instruments in the index. | | 3 | AdditionalPayments | Cash flows relating to any additional payments (optional). | # noqa: E501
|
33
33
|
"""
|
34
34
|
start_date: datetime = Field(..., alias="startDate", description="The start date of the instrument. This is normally synonymous with the trade-date.")
|
35
|
-
maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount.
|
35
|
+
maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.")
|
36
36
|
flow_conventions: Optional[CdsFlowConventions] = Field(None, alias="flowConventions")
|
37
|
-
coupon_rate: Union[StrictFloat, StrictInt] = Field(..., alias="couponRate", description="The coupon rate paid on each payment date of the premium leg as a fraction of 100 percent, e.g. \"0.05\" meaning 500 basis points or 5%.
|
37
|
+
coupon_rate: Union[StrictFloat, StrictInt] = Field(..., alias="couponRate", description="The coupon rate paid on each payment date of the premium leg as a fraction of 100 percent, e.g. \"0.05\" meaning 500 basis points or 5%. For a standard corporate CDS (North American) this must be either 100bps or 500bps.")
|
38
38
|
identifiers: Dict[str, StrictStr] = Field(..., description="External market codes and identifiers for the cds index, e.g. a RED code, BBG ID or ICE code.")
|
39
39
|
basket: Optional[Basket] = None
|
40
40
|
convention_name: Optional[FlowConventionName] = Field(None, alias="conventionName")
|
41
41
|
notional: Union[StrictFloat, StrictInt] = Field(..., description="The notional quantity that applies to both the premium and protection legs.")
|
42
|
-
additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven swap.
|
42
|
+
additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven swap. The dates must be distinct and either all payments are Pay or all payments are Receive.")
|
43
43
|
time_zone_conventions: Optional[TimeZoneConventions] = Field(None, alias="timeZoneConventions")
|
44
44
|
instrument_type: StrictStr = Field(...,alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo")
|
45
45
|
additional_properties: Dict[str, Any] = {}
|
@@ -23,10 +23,10 @@ from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictBool, StrictSt
|
|
23
23
|
|
24
24
|
class CdsProtectionDetailSpecification(BaseModel):
|
25
25
|
"""
|
26
|
-
CDSs generally conform to fairly standard definitions, but can be tweaked in a number of different ways.
|
26
|
+
CDSs generally conform to fairly standard definitions, but can be tweaked in a number of different ways. This class gathers a number of common features which may deviate. These will default to the market standard when no overrides are provided. # noqa: E501
|
27
27
|
"""
|
28
|
-
seniority: Optional[StrictStr] = Field(None,alias="seniority", description="The seniority level of the CDS.
|
29
|
-
restructuring_type: Optional[StrictStr] = Field(None,alias="restructuringType", description="The restructuring clause.
|
28
|
+
seniority: Optional[StrictStr] = Field(None,alias="seniority", description="The seniority level of the CDS. Supported string (enumeration) values are: [SNR, SUB, JRSUBUT2, PREFT1, SECDOM, SNRFOR, SUBLT2]. Defaults to \"SUB\" if not set.")
|
29
|
+
restructuring_type: Optional[StrictStr] = Field(None,alias="restructuringType", description="The restructuring clause. Supported string (enumeration) values are: [CR, MR, MM, XR]. Defaults to \"MM\" if not set.")
|
30
30
|
protect_start_day: Optional[StrictBool] = Field(True, alias="protectStartDay", description="Does the protection leg pay out in the case of default on the start date. Defaults to true if not set.")
|
31
31
|
pay_accrued_interest_on_default: Optional[StrictBool] = Field(True, alias="payAccruedInterestOnDefault", description="Should accrued interest on the premium leg be paid if a credit event occurs. Defaults to true if not set.")
|
32
32
|
__properties = ["seniority", "restructuringType", "protectStartDay", "payAccruedInterestOnDefault"]
|
lusid/models/change_item.py
CHANGED
@@ -23,7 +23,7 @@ from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictStr, constr
|
|
23
23
|
|
24
24
|
class ChangeItem(BaseModel):
|
25
25
|
"""
|
26
|
-
Information about a change to a field / property.
|
26
|
+
Information about a change to a field / property. At least one of 'PreviousValue' or 'NewValue' will be set. # noqa: E501
|
27
27
|
"""
|
28
28
|
field_name: StrictStr = Field(...,alias="fieldName", description="The name of the field or property that has been changed.")
|
29
29
|
previous_value: Optional[StrictStr] = Field(None,alias="previousValue", description="The previous value for this field / property.")
|
lusid/models/close_event.py
CHANGED
@@ -24,7 +24,7 @@ from lusid.models.instrument_event import InstrumentEvent
|
|
24
24
|
|
25
25
|
class CloseEvent(InstrumentEvent):
|
26
26
|
"""
|
27
|
-
The termination of an instrument.
|
27
|
+
The termination of an instrument. In some cases termination can happen over a range of dates e.g. american option exercise. In most cases the startDate == endDate # noqa: E501
|
28
28
|
"""
|
29
29
|
start_date: Optional[datetime] = Field(None, alias="startDate", description="The first date on which the instrument could close")
|
30
30
|
end_date: Optional[datetime] = Field(None, alias="endDate", description="The last date on which the instrument could close")
|
lusid/models/collateral.py
CHANGED
@@ -27,9 +27,9 @@ class Collateral(BaseModel):
|
|
27
27
|
Representation of the collateral of a repurchase agreement, along with related details of the agreement. # noqa: E501
|
28
28
|
"""
|
29
29
|
buyer_receives_cashflows: StrictBool = Field(..., alias="buyerReceivesCashflows", description="Does the buyer of the FlexibleRepo receive the cashflows from any collateral instruments, or do they get paid to the seller.")
|
30
|
-
buyer_receives_corporate_action_payments: StrictBool = Field(..., alias="buyerReceivesCorporateActionPayments", description="Does the buyer of the FlexibleRepo receive any dividend or cash payments as the result of a corporate action
|
30
|
+
buyer_receives_corporate_action_payments: StrictBool = Field(..., alias="buyerReceivesCorporateActionPayments", description="Does the buyer of the FlexibleRepo receive any dividend or cash payments as the result of a corporate action on any of the collateral instruments, or are these amounts paid to the seller. Referred to as \"manufactured payments\" in the UK, and valid only under a repo with GMRA in Europe")
|
31
31
|
collateral_instruments: Optional[conlist(CollateralInstrument)] = Field(None, alias="collateralInstruments", description="List of any collateral instruments.")
|
32
|
-
collateral_value: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="collateralValue", description="Total value of the collateral before any margin or haircut applied.
|
32
|
+
collateral_value: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="collateralValue", description="Total value of the collateral before any margin or haircut applied. Can be provided instead of PurchasePrice, so that PurchasePrice can be inferred from the CollateralValue and one of Haircut or Margin.")
|
33
33
|
__properties = ["buyerReceivesCashflows", "buyerReceivesCorporateActionPayments", "collateralInstruments", "collateralValue"]
|
34
34
|
|
35
35
|
class Config:
|
lusid/models/complex_bond.py
CHANGED
@@ -28,15 +28,15 @@ from lusid.models.trading_conventions import TradingConventions
|
|
28
28
|
|
29
29
|
class ComplexBond(LusidInstrument):
|
30
30
|
"""
|
31
|
-
LUSID representation of a Complex Bond.
|
31
|
+
LUSID representation of a Complex Bond. Including Floating, Fixed-to-float, Sinkable, Callable, Puttable, and Mortgage Backed Securities. # noqa: E501
|
32
32
|
"""
|
33
33
|
identifiers: Optional[Dict[str, StrictStr]] = Field(None, description="External market codes and identifiers for the bond, e.g. ISIN.")
|
34
|
-
calculation_type: Optional[StrictStr] = Field(None,alias="calculationType", description="The calculation type applied to the bond coupon amount. This is required for bonds that have a particular type of computing the period coupon, such as simple compounding,
|
34
|
+
calculation_type: Optional[StrictStr] = Field(None,alias="calculationType", description="The calculation type applied to the bond coupon amount. This is required for bonds that have a particular type of computing the period coupon, such as simple compounding, irregular coupons etc. The default CalculationType is `Standard`, which returns a coupon amount equal to Principal * Coupon Rate / Coupon Frequency. Coupon Frequency is 12M / Payment Frequency. Payment Frequency can be 1M, 3M, 6M, 12M etc. So Coupon Frequency can be 12, 4, 2, 1 respectively. Supported string (enumeration) values are: [Standard, DayCountCoupon, NoCalculationFloater, BrazilFixedCoupon, StandardWithCappedAccruedInterest].")
|
35
35
|
schedules: Optional[conlist(Schedule)] = Field(None, description="schedules.")
|
36
36
|
original_issue_price: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="originalIssuePrice", description="The price the complex bond was issued at. This is to be entered as a percentage of par, for example a value of 98.5 would represent 98.5%.")
|
37
37
|
rounding_conventions: Optional[conlist(RoundingConvention)] = Field(None, alias="roundingConventions", description="Rounding conventions for analytics, if any.")
|
38
|
-
asset_backed: Optional[StrictBool] = Field(None, alias="assetBacked", description="If this flag is set to true, then the outstanding notional and principal repayments will be calculated based
|
39
|
-
asset_pool_identifier: Optional[StrictStr] = Field(None,alias="assetPoolIdentifier", description="Identifier used to retrieve pool factor information about this bond from the quote store. This is typically
|
38
|
+
asset_backed: Optional[StrictBool] = Field(None, alias="assetBacked", description="If this flag is set to true, then the outstanding notional and principal repayments will be calculated based on pool factors in the quote store. Usually AssetBacked bonds also require a RollConvention setting of within the FlowConventions any given rates schedule (to ensure payment dates always happen on the same day of the month) and US Agency MBSs with Pay Delay features also require their rates schedules to include an ExDividendConfiguration to drive the lag between interest accrual and payment.")
|
39
|
+
asset_pool_identifier: Optional[StrictStr] = Field(None,alias="assetPoolIdentifier", description="Identifier used to retrieve pool factor information about this bond from the quote store. This is typically the bond's ISIN, but can also be ClientInternal. Please ensure you align the MarketDataKeyRule with the correct Quote (Quote.ClientInternal.* or Quote.Isin.*)")
|
40
40
|
trading_conventions: Optional[TradingConventions] = Field(None, alias="tradingConventions")
|
41
41
|
time_zone_conventions: Optional[TimeZoneConventions] = Field(None, alias="timeZoneConventions")
|
42
42
|
instrument_type: StrictStr = Field(...,alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo")
|
@@ -24,7 +24,7 @@ import lusid.models
|
|
24
24
|
|
25
25
|
class ComplexMarketData(BaseModel):
|
26
26
|
"""
|
27
|
-
Base class for representing complex market data in LUSID.
|
27
|
+
Base class for representing complex market data in LUSID. Generally speaking, market data is complex when it cannot be represented as a single quote. Examples include discounting curves, projection curves, and volatility surfaces, which are used to compute instrument analytics. This base class should not be directly instantiated; each supported MarketDataType has a corresponding inherited class. # noqa: E501
|
28
28
|
"""
|
29
29
|
market_data_type: StrictStr = Field(...,alias="marketDataType", description="The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface")
|
30
30
|
__properties = ["marketDataType"]
|
@@ -27,7 +27,7 @@ class ComplexMarketDataId(BaseModel):
|
|
27
27
|
"""
|
28
28
|
provider: StrictStr = Field(...,alias="provider", description="The platform or vendor that provided the complex market data, e.g. 'DataScope', 'LUSID', etc.")
|
29
29
|
price_source: Optional[StrictStr] = Field(None,alias="priceSource", description="The source or originator of the complex market data, e.g. a bank or financial institution.")
|
30
|
-
lineage: Optional[StrictStr] = Field(None,alias="lineage", description="This is obsolete. It is not used, it will not be stored, and has no effects.
|
30
|
+
lineage: Optional[StrictStr] = Field(None,alias="lineage", description="This is obsolete. It is not used, it will not be stored, and has no effects. If you wish to attach a Lineage to your ComplexMarketData, you should provide it in the optional Lineage field in the ComplexMarketData class.")
|
31
31
|
effective_at: Optional[StrictStr] = Field(None,alias="effectiveAt", description="The effectiveAt or cut label that this item of complex market data is/was updated/inserted with.")
|
32
32
|
market_asset: StrictStr = Field(...,alias="marketAsset", description="The name of the market entity that the document represents")
|
33
33
|
__properties = ["provider", "priceSource", "lineage", "effectiveAt", "marketAsset"]
|
lusid/models/compounding.py
CHANGED
@@ -25,13 +25,13 @@ class Compounding(BaseModel):
|
|
25
25
|
"""
|
26
26
|
The compounding settings used on interest rate. # noqa: E501
|
27
27
|
"""
|
28
|
-
averaging_method: Optional[StrictStr] = Field(None,alias="averagingMethod", description="Defines whether a weighted or unweighted average is used when calculating the average rate.
|
29
|
-
calculation_shift_method: Optional[StrictStr] = Field(None,alias="calculationShiftMethod", description="Defines which resets and day counts are used for the rate calculation
|
30
|
-
compounding_method: StrictStr = Field(...,alias="compoundingMethod", description="If the interest rate is simple, compounded or using a pre-computed compounded index.
|
31
|
-
reset_frequency: StrictStr = Field(...,alias="resetFrequency", description="The interest payment frequency.
|
28
|
+
averaging_method: Optional[StrictStr] = Field(None,alias="averagingMethod", description="Defines whether a weighted or unweighted average is used when calculating the average rate. It applies only when CompoundingMethod = ‘Averaging‘. Supported string (enumeration) values are: [Unweighted, UnweightedIncludingWeekends, Weighted].")
|
29
|
+
calculation_shift_method: Optional[StrictStr] = Field(None,alias="calculationShiftMethod", description="Defines which resets and day counts are used for the rate calculation Supported string (enumeration) values are: [Lookback, NoShift, ObservationPeriodShift, Lockout].")
|
30
|
+
compounding_method: StrictStr = Field(...,alias="compoundingMethod", description="If the interest rate is simple, compounded or using a pre-computed compounded index. Supported string (enumeration) values are: [Averaging, Compounding, CompoundedIndex, NonCumulativeCompounding].")
|
31
|
+
reset_frequency: StrictStr = Field(...,alias="resetFrequency", description="The interest payment frequency. For more information on tenors, see [knowledge base article KA-02097](https://support.lusid.com/knowledgebase/article/KA-02097)")
|
32
32
|
shift: Optional[StrictInt] = Field(None, description="Defines the number of days to lockout or shift observation period by - should be a non-negative integer")
|
33
|
-
spread_compounding_method: Optional[StrictStr] = Field(None,alias="spreadCompoundingMethod", description="Defines how the computed leg spread is applied to compounded rate.
|
34
|
-
rounding_precision: Optional[StrictInt] = Field(None, alias="roundingPrecision", description="Defines the number of decimal places the compounded rate (expressed as a decimal) should be rounded to.
|
33
|
+
spread_compounding_method: Optional[StrictStr] = Field(None,alias="spreadCompoundingMethod", description="Defines how the computed leg spread is applied to compounded rate. It applies only when CompoundingMethod = ‘Compounding‘ or ‘CompoundedIndex‘. Available compounding methods: | Method | Description | | ------ | ----------- | | Straight | Compounding rate in each compound period includes the spread. | | Flat | Compounding rate does not include the spread, and the spread is used for simple interest in each compound period. | | SpreadExclusive | Compounding rate does not include the spread, and the spread is used for simple interest for whole accrual period. | The values \"IsdaCompounding\", \"NoCompounding\", \"IsdaFlatCompounding\", and \"None\" are accepted for compatibility with existing instruments and their use is discouraged. Supported string (enumeration) values are: [Straight, IsdaCompounding, NoCompounding, SpreadExclusive, IsdaFlatCompounding, Flat, None].")
|
34
|
+
rounding_precision: Optional[StrictInt] = Field(None, alias="roundingPrecision", description="Defines the number of decimal places the compounded rate (expressed as a decimal) should be rounded to. This is an optional field, leaving it blank will mean no rounding takes place in Compounding.")
|
35
35
|
__properties = ["averagingMethod", "calculationShiftMethod", "compoundingMethod", "resetFrequency", "shift", "spreadCompoundingMethod", "roundingPrecision"]
|
36
36
|
|
37
37
|
class Config:
|
@@ -28,7 +28,7 @@ from lusid.models.translation_context import TranslationContext
|
|
28
28
|
|
29
29
|
class ConfigurationRecipe(BaseModel):
|
30
30
|
"""
|
31
|
-
The Configuration or Calculation Recipe controls how LUSID processes a given request.
|
31
|
+
The Configuration or Calculation Recipe controls how LUSID processes a given request. This can be used to change where market data used in pricing is loaded from and in what order, or which model is used to price a given instrument as well as how aggregation will process the produced results. # noqa: E501
|
32
32
|
"""
|
33
33
|
scope: StrictStr = Field(...,alias="scope", description="The scope used when updating or inserting the Configuration Recipe.")
|
34
34
|
code: StrictStr = Field(...,alias="code", description="User given string name (code) to identify the recipe.")
|
@@ -24,10 +24,10 @@ from lusid.models.complex_market_data import ComplexMarketData
|
|
24
24
|
|
25
25
|
class ConstantVolatilitySurface(ComplexMarketData):
|
26
26
|
"""
|
27
|
-
Market Data required to build a volatility surface for pricing.
|
27
|
+
Market Data required to build a volatility surface for pricing. Single constant volatility point. # noqa: E501
|
28
28
|
"""
|
29
29
|
base_date: datetime = Field(..., alias="baseDate", description="Base date of the engine - this is the reference date for resolution of tenors.")
|
30
|
-
asset_type: StrictStr = Field(...,alias="assetType", description="What is the asset that the engine is for.
|
30
|
+
asset_type: StrictStr = Field(...,alias="assetType", description="What is the asset that the engine is for. Supported string (enumeration) values are: [Cash, Commodity, Credit, Equity, Fx, Rates, FxVol, IrVol, EquityVol, HolidayCalendar, IndexConvention, FlowConvention, CdsFlowConvention, CorporateActions, FxForwards, Quote, Inflation, EquityCurve, All, VendorOpaque].")
|
31
31
|
lineage: Optional[StrictStr] = Field(None,alias="lineage")
|
32
32
|
volatility: Union[StrictFloat, StrictInt] = Field(..., description="Volatility value.")
|
33
33
|
market_data_type: StrictStr = Field(...,alias="marketDataType", description="The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface")
|
@@ -27,7 +27,7 @@ class ConstituentsAdjustmentHeader(BaseModel):
|
|
27
27
|
"""
|
28
28
|
ConstituentsAdjustmentHeader
|
29
29
|
"""
|
30
|
-
effective_at: Optional[datetime] = Field(None, alias="effectiveAt", description="There can be at most one holdings adjustment for a portfolio at a
|
30
|
+
effective_at: Optional[datetime] = Field(None, alias="effectiveAt", description="There can be at most one holdings adjustment for a portfolio at a specific effective time so this uniquely identifies the adjustment.")
|
31
31
|
version: Optional[Version] = None
|
32
32
|
links: Optional[conlist(Link)] = None
|
33
33
|
__properties = ["effectiveAt", "version", "links"]
|
@@ -28,15 +28,15 @@ class ContractForDifference(LusidInstrument):
|
|
28
28
|
LUSID representation of a Contract for Difference. # noqa: E501
|
29
29
|
"""
|
30
30
|
start_date: datetime = Field(..., alias="startDate", description="The start date of the CFD.")
|
31
|
-
maturity_date: Optional[datetime] = Field(None, alias="maturityDate", description="The maturity date for the CFD. If CFDType is Futures, this should be set to be the maturity date of the underlying
|
31
|
+
maturity_date: Optional[datetime] = Field(None, alias="maturityDate", description="The maturity date for the CFD. If CFDType is Futures, this should be set to be the maturity date of the underlying future. If CFDType is Cash, this should not be set.")
|
32
32
|
code: Optional[StrictStr] = Field(None,alias="code", description="The code of the underlying.")
|
33
|
-
contract_size: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="contractSize", description="The size of the CFD contract, this should represent the total number of stocks that the CFD represents.
|
33
|
+
contract_size: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="contractSize", description="The size of the CFD contract, this should represent the total number of stocks that the CFD represents. This field is optional, if not set it will default to 1.")
|
34
34
|
pay_ccy: StrictStr = Field(...,alias="payCcy", description="The currency that this CFD pays out, this can be different to the UnderlyingCcy.")
|
35
|
-
reference_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="referenceRate", description="The reference rate of the CFD, this can be set to 0 but not negative values.
|
36
|
-
type: StrictStr = Field(...,alias="type", description="The type of CFD.
|
35
|
+
reference_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="referenceRate", description="The reference rate of the CFD, this can be set to 0 but not negative values. This field is optional, if not set it will default to 0.")
|
36
|
+
type: StrictStr = Field(...,alias="type", description="The type of CFD. Supported string (enumeration) values are: [Cash, Futures].")
|
37
37
|
underlying_ccy: Optional[StrictStr] = Field(None,alias="underlyingCcy", description="The currency of the underlying")
|
38
|
-
underlying_identifier: Optional[StrictStr] = Field(None,alias="underlyingIdentifier", description="External market codes and identifiers for the CFD, e.g. RIC.
|
39
|
-
lot_size: Optional[StrictInt] = Field(None, alias="lotSize", description="CFD LotSize, the minimum number of shares that can be bought or sold at once.
|
38
|
+
underlying_identifier: Optional[StrictStr] = Field(None,alias="underlyingIdentifier", description="External market codes and identifiers for the CFD, e.g. RIC. Supported string (enumeration) values are: [LusidInstrumentId, Isin, Sedol, Cusip, ClientInternal, Figi, RIC, QuotePermId, REDCode, BBGId, ICECode].")
|
39
|
+
lot_size: Optional[StrictInt] = Field(None, alias="lotSize", description="CFD LotSize, the minimum number of shares that can be bought or sold at once. Optional, if set must be non-negative, if not set defaults to 1.")
|
40
40
|
underlying: Optional[LusidInstrument] = None
|
41
41
|
time_zone_conventions: Optional[TimeZoneConventions] = Field(None, alias="timeZoneConventions")
|
42
42
|
instrument_type: StrictStr = Field(...,alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo")
|
lusid/models/conversion_event.py
CHANGED
@@ -29,19 +29,19 @@ from lusid.models.security_offer_election import SecurityOfferElection
|
|
29
29
|
|
30
30
|
class ConversionEvent(InstrumentEvent):
|
31
31
|
"""
|
32
|
-
Conversion Event (CONV) - Conversion of securities (generally convertible bonds or preferred shares) into
|
32
|
+
Conversion Event (CONV) - Conversion of securities (generally convertible bonds or preferred shares) into another form of securities (usually common shares) at a pre-stated price/ratio. # noqa: E501
|
33
33
|
"""
|
34
|
-
record_date: Optional[datetime] = Field(None, alias="recordDate", description="Required.
|
34
|
+
record_date: Optional[datetime] = Field(None, alias="recordDate", description="Required. Date at which positions are struck at the end of the day to note which parties will receive the relevant amount of entitlement, due to be distributed on the Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.PaymentDate.")
|
35
35
|
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Required. Date on which the movement is due to take place (cash and/or securities).")
|
36
36
|
new_instrument: NewInstrument = Field(..., alias="newInstrument")
|
37
|
-
response_deadline_date: Optional[datetime] = Field(None, alias="responseDeadlineDate", description="Date/time that the account servicer has set as the deadline to respond,
|
38
|
-
market_deadline_date: Optional[datetime] = Field(None, alias="marketDeadlineDate", description="Date/time which the issuer or issuer's agent has set as the deadline to respond,
|
37
|
+
response_deadline_date: Optional[datetime] = Field(None, alias="responseDeadlineDate", description="Date/time that the account servicer has set as the deadline to respond, with instructions, to an outstanding event. Not required.")
|
38
|
+
market_deadline_date: Optional[datetime] = Field(None, alias="marketDeadlineDate", description="Date/time which the issuer or issuer's agent has set as the deadline to respond, with an instruction, to an outstanding offer or privilege. Not required.")
|
39
39
|
period_of_action: Optional[EventDateRange] = Field(None, alias="periodOfAction")
|
40
|
-
fractional_units_cash_price: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="fractionalUnitsCashPrice", description="The cash price paid in lieu of fractionalUnits. Not required.
|
41
|
-
fractional_units_cash_currency: Optional[StrictStr] = Field(None,alias="fractionalUnitsCashCurrency", description="Optional. Used in calculating cash-in-lieu of fractional shares. Not required.
|
42
|
-
security_offer_elections: Optional[conlist(SecurityOfferElection)] = Field(None, alias="securityOfferElections", description="List of possible security offers for this conversion event. There must be at most one election of this type.
|
43
|
-
cash_and_security_offer_elections: Optional[conlist(CashAndSecurityOfferElection)] = Field(None, alias="cashAndSecurityOfferElections", description="List of possible cash and security offers for this conversion event. There must be at most one election of this type.
|
44
|
-
cash_offer_elections: Optional[conlist(CashOfferElection)] = Field(None, alias="cashOfferElections", description="List of possible cash offers for this conversion event. There must be at most one election of this type.
|
40
|
+
fractional_units_cash_price: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="fractionalUnitsCashPrice", description="The cash price paid in lieu of fractionalUnits. Not required. If provided, must have Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.FractionalUnitsCashCurrency too.")
|
41
|
+
fractional_units_cash_currency: Optional[StrictStr] = Field(None,alias="fractionalUnitsCashCurrency", description="Optional. Used in calculating cash-in-lieu of fractional shares. Not required. If provided, must have Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.FractionalUnitsCashPrice too.")
|
42
|
+
security_offer_elections: Optional[conlist(SecurityOfferElection)] = Field(None, alias="securityOfferElections", description="List of possible security offers for this conversion event. There must be at most one election of this type. If the Finbourne.LusidInstruments.Events.ParticipationType is Finbourne.LusidInstruments.Events.ParticipationType.Mandatory: This list must have exactly one election that is chosen and default. Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.CashAndSecurityOfferElections and Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.CashOfferElections<b> must be null or empty</b>. If the Finbourne.LusidInstruments.Events.ParticipationType is Finbourne.LusidInstruments.Events.ParticipationType.Voluntary: This list can be empty, so long as Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.CashAndSecurityOfferElections or Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.CashOfferElections has at least one election. None of these elections have to be chosen or default.")
|
43
|
+
cash_and_security_offer_elections: Optional[conlist(CashAndSecurityOfferElection)] = Field(None, alias="cashAndSecurityOfferElections", description="List of possible cash and security offers for this conversion event. There must be at most one election of this type. If the Finbourne.LusidInstruments.Events.ParticipationType is Finbourne.LusidInstruments.Events.ParticipationType.Mandatory: This list <b> must be null or empty</b>. If the Finbourne.LusidInstruments.Events.ParticipationType is Finbourne.LusidInstruments.Events.ParticipationType.Voluntary: This list can be empty, so long as Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.SecurityOfferElections or Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.CashOfferElections has at least one election. None of these elections have to be chosen or default.")
|
44
|
+
cash_offer_elections: Optional[conlist(CashOfferElection)] = Field(None, alias="cashOfferElections", description="List of possible cash offers for this conversion event. There must be at most one election of this type. If the Finbourne.LusidInstruments.Events.ParticipationType is Finbourne.LusidInstruments.Events.ParticipationType.Mandatory: This list <b> must be null or empty</b>. If the Finbourne.LusidInstruments.Events.ParticipationType is Finbourne.LusidInstruments.Events.ParticipationType.Voluntary: This list can be empty, so long as Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.SecurityOfferElections or Finbourne.WebApi.Interface.Dto.InstrumentEvents.ConversionEvent.CashAndSecurityOfferElections has at least one election. None of these elections have to be chosen or default.")
|
45
45
|
instrument_event_type: StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent")
|
46
46
|
additional_properties: Dict[str, Any] = {}
|
47
47
|
__properties = ["instrumentEventType", "recordDate", "paymentDate", "newInstrument", "responseDeadlineDate", "marketDeadlineDate", "periodOfAction", "fractionalUnitsCashPrice", "fractionalUnitsCashCurrency", "securityOfferElections", "cashAndSecurityOfferElections", "cashOfferElections"]
|
@@ -23,7 +23,7 @@ from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictFloat, StrictI
|
|
23
23
|
|
24
24
|
class CorporateActionTransitionComponentRequest(BaseModel):
|
25
25
|
"""
|
26
|
-
A single transition component request, when grouped with other transition component requests a corporate action
|
26
|
+
A single transition component request, when grouped with other transition component requests a corporate action transition request is formed. # noqa: E501
|
27
27
|
"""
|
28
28
|
instrument_identifiers: Dict[str, StrictStr] = Field(..., alias="instrumentIdentifiers", description="Unique instrument identifiers")
|
29
29
|
units_factor: Union[StrictFloat, StrictInt] = Field(..., alias="unitsFactor", description="The factor to scale units by")
|
@@ -25,7 +25,7 @@ from lusid.models.resource_id import ResourceId
|
|
25
25
|
|
26
26
|
class CounterpartyAgreement(BaseModel):
|
27
27
|
"""
|
28
|
-
Represents the legal agreement between two parties engaged in an OTC transaction.
|
28
|
+
Represents the legal agreement between two parties engaged in an OTC transaction. A typical example would be a 2002 ISDA Master Agreement, signed by two legal entities on a given date. # noqa: E501
|
29
29
|
"""
|
30
30
|
display_name: StrictStr = Field(...,alias="displayName", description="A user-defined display label for the Counterparty Agreement.")
|
31
31
|
agreement_type: StrictStr = Field(...,alias="agreementType", description="A user-defined field to capture the type of agreement this represents. Examples might be \"ISDA 2002 Master Agreement\" or \"ISDA 1992 Master Agreement\".")
|
@@ -25,7 +25,7 @@ from lusid.models.industry_classifier import IndustryClassifier
|
|
25
25
|
|
26
26
|
class CounterpartyRiskInformation(BaseModel):
|
27
27
|
"""
|
28
|
-
In the event that the legal entity is a counterparty to an OTC transaction
|
28
|
+
In the event that the legal entity is a counterparty to an OTC transaction (as signatory to a counterparty agreement such as an ISDA 2002 Master Agreement), this information would be needed for calculations such as Credit-Valuation-Adjustments and Debit-Valuation-Adjustments (CVA, DVA, XVA etc). # noqa: E501
|
29
29
|
"""
|
30
30
|
country_of_risk: StrictStr = Field(...,alias="countryOfRisk", description="The country to which one would naturally ascribe risk, typically the legal entity's country of registration. This can be used to infer funding currency and related market data in the absence of a specific preference.")
|
31
31
|
credit_ratings: conlist(CreditRating) = Field(..., alias="creditRatings")
|
@@ -24,7 +24,7 @@ from lusid.models.typed_resource_id import TypedResourceId
|
|
24
24
|
|
25
25
|
class CounterpartySignatory(BaseModel):
|
26
26
|
"""
|
27
|
-
The counterpartyAgreement is signed by two parties, one of which is implicitly the LUSID user.
|
27
|
+
The counterpartyAgreement is signed by two parties, one of which is implicitly the LUSID user. The CounterpartySignatory represents the 'other side' of the agreement. It comprises a name and identifier for a Legal Entity in LUSID. # noqa: E501
|
28
28
|
"""
|
29
29
|
name: StrictStr = Field(...,alias="name", description="A user-defined name or label for the counterparty signatory. There is no requirement for this to match the \"displayName\" of the legal entity.")
|
30
30
|
legal_entity_identifier: TypedResourceId = Field(..., alias="legalEntityIdentifier")
|
@@ -29,17 +29,17 @@ from lusid.models.time_zone_conventions import TimeZoneConventions
|
|
29
29
|
|
30
30
|
class CreditDefaultSwap(LusidInstrument):
|
31
31
|
"""
|
32
|
-
LUSID representation of a Credit Default Swap (CDS).
|
32
|
+
LUSID representation of a Credit Default Swap (CDS). This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252). | Leg Index | Leg Identifier | Description | | --------- | -------------- | ----------- | | 1 | ProtectionLeg | Cash flows occurring in the case of default. | | 2 | PremiumLeg | The premium payments made by the protection buyer. | | 3 | AdditionalPayments | Cash flows relating to any additional payments (optional). | # noqa: E501
|
33
33
|
"""
|
34
34
|
ticker: Optional[StrictStr] = Field(None,alias="ticker", description="A ticker to uniquely specify the entity against which the CDS is written. Defaults to \"DefaultCDSTicker\".")
|
35
35
|
start_date: datetime = Field(..., alias="startDate", description="The start date of the instrument. This is normally synonymous with the trade-date.")
|
36
|
-
maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount.
|
36
|
+
maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.")
|
37
37
|
flow_conventions: Optional[CdsFlowConventions] = Field(None, alias="flowConventions")
|
38
|
-
coupon_rate: Union[StrictFloat, StrictInt] = Field(..., alias="couponRate", description="The coupon rate paid on each payment date of the premium leg as a fraction of 100 percent, e.g. \"0.05\" meaning 500 basis points or 5%.
|
38
|
+
coupon_rate: Union[StrictFloat, StrictInt] = Field(..., alias="couponRate", description="The coupon rate paid on each payment date of the premium leg as a fraction of 100 percent, e.g. \"0.05\" meaning 500 basis points or 5%. For a standard corporate CDS (North American) this must be either 100bps or 500bps.")
|
39
39
|
convention_name: Optional[FlowConventionName] = Field(None, alias="conventionName")
|
40
40
|
notional: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The notional protected by the Credit Default Swap")
|
41
41
|
protection_detail_specification: Optional[CdsProtectionDetailSpecification] = Field(None, alias="protectionDetailSpecification")
|
42
|
-
additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven swap.
|
42
|
+
additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven swap. The dates must be distinct and either all payments are Pay or all payments are Receive.")
|
43
43
|
time_zone_conventions: Optional[TimeZoneConventions] = Field(None, alias="timeZoneConventions")
|
44
44
|
instrument_type: StrictStr = Field(...,alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility, FlexibleDeposit, FlexibleRepo")
|
45
45
|
additional_properties: Dict[str, Any] = {}
|
@@ -24,7 +24,7 @@ from lusid.models.instrument_event import InstrumentEvent
|
|
24
24
|
|
25
25
|
class CreditPremiumCashFlowEvent(InstrumentEvent):
|
26
26
|
"""
|
27
|
-
Definition of a credit premium cash flow event.
|
27
|
+
Definition of a credit premium cash flow event. This event describes a premium cashflow for credit default instruments (CDS or CDX). # noqa: E501
|
28
28
|
"""
|
29
29
|
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex-dividend date of the cashflow.")
|
30
30
|
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the cashflow.")
|
lusid/models/credit_rating.py
CHANGED
@@ -23,7 +23,7 @@ from pydantic.v1 import StrictStr, Field, BaseModel, Field, constr, validator
|
|
23
23
|
|
24
24
|
class CreditRating(BaseModel):
|
25
25
|
"""
|
26
|
-
Object describing a credit rating,
|
26
|
+
Object describing a credit rating, which assesses the stability and credit worthiness of a legal entity and hence its likelihood of defaulting on its outstanding obligations (typically debt). # noqa: E501
|
27
27
|
"""
|
28
28
|
rating_source: StrictStr = Field(...,alias="ratingSource", description="The provider of the credit rating, which will typically be an agency such as Moody's or Standard and Poor.")
|
29
29
|
rating: StrictStr = Field(...,alias="rating", description="The credit rating provided by the rating source. This would expected to be consistent with the rating scheme of that agency/source.")
|