lusid-sdk 2.1.910__py3-none-any.whl → 2.1.912__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/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.910.dist-info → lusid_sdk-2.1.912.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/WHEEL +0 -0
lusid/api/portfolios_api.py
CHANGED
@@ -97,7 +97,7 @@ class PortfoliosApi:
|
|
97
97
|
def batch_upsert_portfolio_access_metadata(self, request_body : Annotated[Dict[str, BatchUpsertPortfolioAccessMetadataRequest], Field(..., description="The Access Metadata Rules to upsert and the Portfolio identifiers to upsert for")], effective_at : Annotated[Optional[StrictStr], Field( description="The date these rules will be effective from")] = None, effective_until : Annotated[Optional[StrictStr], Field( description="The effective date until which the Access Metadata is valid. If not supplied, this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpsertPortfolioAccessMetadataResponse, Awaitable[BatchUpsertPortfolioAccessMetadataResponse]]: # noqa: E501
|
98
98
|
"""[EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios # noqa: E501
|
99
99
|
|
100
|
-
Update or insert multiple Access Metadata rules for multiple Portfolios. Items will be updated if they already exist
|
100
|
+
Update or insert multiple Access Metadata rules for multiple Portfolios. Items will be updated if they already exist and inserted if they do not. No other items will be affected The response will return the successfully updated or inserted Portfolio Access Metadata Rules or a failure message if unsuccessful Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched # noqa: E501
|
101
101
|
This method makes a synchronous HTTP request by default. To make an
|
102
102
|
asynchronous HTTP request, please pass async_req=True
|
103
103
|
|
@@ -132,7 +132,7 @@ class PortfoliosApi:
|
|
132
132
|
def batch_upsert_portfolio_access_metadata_with_http_info(self, request_body : Annotated[Dict[str, BatchUpsertPortfolioAccessMetadataRequest], Field(..., description="The Access Metadata Rules to upsert and the Portfolio identifiers to upsert for")], effective_at : Annotated[Optional[StrictStr], Field( description="The date these rules will be effective from")] = None, effective_until : Annotated[Optional[StrictStr], Field( description="The effective date until which the Access Metadata is valid. If not supplied, this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
133
133
|
"""[EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios # noqa: E501
|
134
134
|
|
135
|
-
Update or insert multiple Access Metadata rules for multiple Portfolios. Items will be updated if they already exist
|
135
|
+
Update or insert multiple Access Metadata rules for multiple Portfolios. Items will be updated if they already exist and inserted if they do not. No other items will be affected The response will return the successfully updated or inserted Portfolio Access Metadata Rules or a failure message if unsuccessful Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched # noqa: E501
|
136
136
|
This method makes a synchronous HTTP request by default. To make an
|
137
137
|
asynchronous HTTP request, please pass async_req=True
|
138
138
|
|
@@ -635,7 +635,7 @@ class PortfoliosApi:
|
|
635
635
|
def delete_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
636
636
|
"""DeletePortfolio: Delete portfolio # noqa: E501
|
637
637
|
|
638
|
-
Delete a particular portfolio.
|
638
|
+
Delete a particular portfolio. The deletion will take effect from the portfolio's creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion. # noqa: E501
|
639
639
|
This method makes a synchronous HTTP request by default. To make an
|
640
640
|
asynchronous HTTP request, please pass async_req=True
|
641
641
|
|
@@ -668,7 +668,7 @@ class PortfoliosApi:
|
|
668
668
|
def delete_portfolio_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], **kwargs) -> ApiResponse: # noqa: E501
|
669
669
|
"""DeletePortfolio: Delete portfolio # noqa: E501
|
670
670
|
|
671
|
-
Delete a particular portfolio.
|
671
|
+
Delete a particular portfolio. The deletion will take effect from the portfolio's creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion. # noqa: E501
|
672
672
|
This method makes a synchronous HTTP request by default. To make an
|
673
673
|
asynchronous HTTP request, please pass async_req=True
|
674
674
|
|
@@ -784,18 +784,18 @@ class PortfoliosApi:
|
|
784
784
|
|
785
785
|
|
786
786
|
@overload
|
787
|
-
async def delete_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format
|
787
|
+
async def delete_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
788
788
|
...
|
789
789
|
|
790
790
|
@overload
|
791
|
-
def delete_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format
|
791
|
+
def delete_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
792
792
|
...
|
793
793
|
|
794
794
|
@validate_arguments
|
795
|
-
def delete_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format
|
795
|
+
def delete_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
796
796
|
"""DeletePortfolioProperties: Delete portfolio properties # noqa: E501
|
797
797
|
|
798
|
-
Delete one or more properties from a particular portfolio. If the properties are time-variant then an effective datetime from which
|
798
|
+
Delete one or more properties from a particular portfolio. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. # noqa: E501
|
799
799
|
This method makes a synchronous HTTP request by default. To make an
|
800
800
|
asynchronous HTTP request, please pass async_req=True
|
801
801
|
|
@@ -806,9 +806,9 @@ class PortfoliosApi:
|
|
806
806
|
:type scope: str
|
807
807
|
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
808
808
|
:type code: str
|
809
|
-
:param property_keys: The property keys of the properties to delete. These must take the format
|
809
|
+
:param property_keys: The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain. (required)
|
810
810
|
:type property_keys: List[str]
|
811
|
-
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from.
|
811
|
+
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
|
812
812
|
:type effective_at: str
|
813
813
|
:param async_req: Whether to execute the request asynchronously.
|
814
814
|
:type async_req: bool, optional
|
@@ -829,10 +829,10 @@ class PortfoliosApi:
|
|
829
829
|
return self.delete_portfolio_properties_with_http_info(scope, code, property_keys, effective_at, **kwargs) # noqa: E501
|
830
830
|
|
831
831
|
@validate_arguments
|
832
|
-
def delete_portfolio_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format
|
832
|
+
def delete_portfolio_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
833
833
|
"""DeletePortfolioProperties: Delete portfolio properties # noqa: E501
|
834
834
|
|
835
|
-
Delete one or more properties from a particular portfolio. If the properties are time-variant then an effective datetime from which
|
835
|
+
Delete one or more properties from a particular portfolio. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. # noqa: E501
|
836
836
|
This method makes a synchronous HTTP request by default. To make an
|
837
837
|
asynchronous HTTP request, please pass async_req=True
|
838
838
|
|
@@ -843,9 +843,9 @@ class PortfoliosApi:
|
|
843
843
|
:type scope: str
|
844
844
|
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
845
845
|
:type code: str
|
846
|
-
:param property_keys: The property keys of the properties to delete. These must take the format
|
846
|
+
:param property_keys: The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain. (required)
|
847
847
|
:type property_keys: List[str]
|
848
|
-
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from.
|
848
|
+
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
|
849
849
|
:type effective_at: str
|
850
850
|
:param async_req: Whether to execute the request asynchronously.
|
851
851
|
:type async_req: bool, optional
|
@@ -1172,7 +1172,7 @@ class PortfoliosApi:
|
|
1172
1172
|
def get_aggregated_returns_dispersion_metrics(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], aggregated_returns_dispersion_request : Annotated[AggregatedReturnsDispersionRequest, Field(..., description="The request used in the AggregatedReturnsDispersionMetric.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CompositeDispersionResponse, Awaitable[CompositeDispersionResponse]]: # noqa: E501
|
1173
1173
|
"""[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric # noqa: E501
|
1174
1174
|
|
1175
|
-
Calculate the dispersion metric with the Aggregate Returns which are on the specified portfolio.
|
1175
|
+
Calculate the dispersion metric with the Aggregate Returns which are on the specified portfolio. This works only for composites which have at least 6 constituents for a full year in. # noqa: E501
|
1176
1176
|
This method makes a synchronous HTTP request by default. To make an
|
1177
1177
|
asynchronous HTTP request, please pass async_req=True
|
1178
1178
|
|
@@ -1209,7 +1209,7 @@ class PortfoliosApi:
|
|
1209
1209
|
def get_aggregated_returns_dispersion_metrics_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], aggregated_returns_dispersion_request : Annotated[AggregatedReturnsDispersionRequest, Field(..., description="The request used in the AggregatedReturnsDispersionMetric.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1210
1210
|
"""[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric # noqa: E501
|
1211
1211
|
|
1212
|
-
Calculate the dispersion metric with the Aggregate Returns which are on the specified portfolio.
|
1212
|
+
Calculate the dispersion metric with the Aggregate Returns which are on the specified portfolio. This works only for composites which have at least 6 constituents for a full year in. # noqa: E501
|
1213
1213
|
This method makes a synchronous HTTP request by default. To make an
|
1214
1214
|
asynchronous HTTP request, please pass async_req=True
|
1215
1215
|
|
@@ -1736,15 +1736,15 @@ class PortfoliosApi:
|
|
1736
1736
|
|
1737
1737
|
|
1738
1738
|
@overload
|
1739
|
-
async def get_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto the portfolio,
|
1739
|
+
async def get_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> Portfolio: # noqa: E501
|
1740
1740
|
...
|
1741
1741
|
|
1742
1742
|
@overload
|
1743
|
-
def get_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto the portfolio,
|
1743
|
+
def get_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> Portfolio: # noqa: E501
|
1744
1744
|
...
|
1745
1745
|
|
1746
1746
|
@validate_arguments
|
1747
|
-
def get_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto the portfolio,
|
1747
|
+
def get_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Portfolio, Awaitable[Portfolio]]: # noqa: E501
|
1748
1748
|
"""GetPortfolio: Get portfolio # noqa: E501
|
1749
1749
|
|
1750
1750
|
Retrieve the definition of a particular portfolio. # noqa: E501
|
@@ -1762,9 +1762,9 @@ class PortfoliosApi:
|
|
1762
1762
|
:type effective_at: str
|
1763
1763
|
:param as_at: The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.
|
1764
1764
|
:type as_at: datetime
|
1765
|
-
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto the portfolio,
|
1765
|
+
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
1766
1766
|
:type property_keys: List[str]
|
1767
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
1767
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
1768
1768
|
:type relationship_definition_ids: List[str]
|
1769
1769
|
:param async_req: Whether to execute the request asynchronously.
|
1770
1770
|
:type async_req: bool, optional
|
@@ -1785,7 +1785,7 @@ class PortfoliosApi:
|
|
1785
1785
|
return self.get_portfolio_with_http_info(scope, code, effective_at, as_at, property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
1786
1786
|
|
1787
1787
|
@validate_arguments
|
1788
|
-
def get_portfolio_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto the portfolio,
|
1788
|
+
def get_portfolio_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1789
1789
|
"""GetPortfolio: Get portfolio # noqa: E501
|
1790
1790
|
|
1791
1791
|
Retrieve the definition of a particular portfolio. # noqa: E501
|
@@ -1803,9 +1803,9 @@ class PortfoliosApi:
|
|
1803
1803
|
:type effective_at: str
|
1804
1804
|
:param as_at: The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.
|
1805
1805
|
:type as_at: datetime
|
1806
|
-
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto the portfolio,
|
1806
|
+
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
1807
1807
|
:type property_keys: List[str]
|
1808
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
1808
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
1809
1809
|
:type relationship_definition_ids: List[str]
|
1810
1810
|
:param async_req: Whether to execute the request asynchronously.
|
1811
1811
|
:type async_req: bool, optional
|
@@ -1933,15 +1933,15 @@ class PortfoliosApi:
|
|
1933
1933
|
|
1934
1934
|
|
1935
1935
|
@overload
|
1936
|
-
async def get_portfolio_aggregate_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], return_scope : Annotated[StrictStr, Field(..., description="The scope of the Returns.")], return_code : Annotated[StrictStr, Field(..., description="The code of the Returns.")], recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The Recipe Scope for getting the fx rates")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The Recipe Code for getting the fx rates")] = None, from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date for which to calculate the Returns.")] = None, composite_method : Annotated[Optional[StrictStr], Field( description="The method used to calculate the Portfolio performance:
|
1936
|
+
async def get_portfolio_aggregate_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], return_scope : Annotated[StrictStr, Field(..., description="The scope of the Returns.")], return_code : Annotated[StrictStr, Field(..., description="The code of the Returns.")], recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The Recipe Scope for getting the fx rates")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The Recipe Code for getting the fx rates")] = None, from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date for which to calculate the Returns.")] = None, composite_method : Annotated[Optional[StrictStr], Field( description="The method used to calculate the Portfolio performance: Equal/Asset.")] = None, period : Annotated[Optional[StrictStr], Field( description="The type of the returns used to calculate the aggregation result: Daily/Monthly.")] = None, output_frequency : Annotated[Optional[StrictStr], Field( description="The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.")] = None, metrics : Annotated[Optional[conlist(StrictStr)], Field(description="Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, alternative_inc_date : Annotated[Optional[StrictStr], Field( description="The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property.")] = None, **kwargs) -> ResourceListOfAggregatedReturn: # noqa: E501
|
1937
1937
|
...
|
1938
1938
|
|
1939
1939
|
@overload
|
1940
|
-
def get_portfolio_aggregate_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], return_scope : Annotated[StrictStr, Field(..., description="The scope of the Returns.")], return_code : Annotated[StrictStr, Field(..., description="The code of the Returns.")], recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The Recipe Scope for getting the fx rates")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The Recipe Code for getting the fx rates")] = None, from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date for which to calculate the Returns.")] = None, composite_method : Annotated[Optional[StrictStr], Field( description="The method used to calculate the Portfolio performance:
|
1940
|
+
def get_portfolio_aggregate_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], return_scope : Annotated[StrictStr, Field(..., description="The scope of the Returns.")], return_code : Annotated[StrictStr, Field(..., description="The code of the Returns.")], recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The Recipe Scope for getting the fx rates")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The Recipe Code for getting the fx rates")] = None, from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date for which to calculate the Returns.")] = None, composite_method : Annotated[Optional[StrictStr], Field( description="The method used to calculate the Portfolio performance: Equal/Asset.")] = None, period : Annotated[Optional[StrictStr], Field( description="The type of the returns used to calculate the aggregation result: Daily/Monthly.")] = None, output_frequency : Annotated[Optional[StrictStr], Field( description="The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.")] = None, metrics : Annotated[Optional[conlist(StrictStr)], Field(description="Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, alternative_inc_date : Annotated[Optional[StrictStr], Field( description="The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfAggregatedReturn: # noqa: E501
|
1941
1941
|
...
|
1942
1942
|
|
1943
1943
|
@validate_arguments
|
1944
|
-
def get_portfolio_aggregate_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], return_scope : Annotated[StrictStr, Field(..., description="The scope of the Returns.")], return_code : Annotated[StrictStr, Field(..., description="The code of the Returns.")], recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The Recipe Scope for getting the fx rates")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The Recipe Code for getting the fx rates")] = None, from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date for which to calculate the Returns.")] = None, composite_method : Annotated[Optional[StrictStr], Field( description="The method used to calculate the Portfolio performance:
|
1944
|
+
def get_portfolio_aggregate_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], return_scope : Annotated[StrictStr, Field(..., description="The scope of the Returns.")], return_code : Annotated[StrictStr, Field(..., description="The code of the Returns.")], recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The Recipe Scope for getting the fx rates")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The Recipe Code for getting the fx rates")] = None, from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date for which to calculate the Returns.")] = None, composite_method : Annotated[Optional[StrictStr], Field( description="The method used to calculate the Portfolio performance: Equal/Asset.")] = None, period : Annotated[Optional[StrictStr], Field( description="The type of the returns used to calculate the aggregation result: Daily/Monthly.")] = None, output_frequency : Annotated[Optional[StrictStr], Field( description="The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.")] = None, metrics : Annotated[Optional[conlist(StrictStr)], Field(description="Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, alternative_inc_date : Annotated[Optional[StrictStr], Field( description="The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAggregatedReturn, Awaitable[ResourceListOfAggregatedReturn]]: # noqa: E501
|
1945
1945
|
"""[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). # noqa: E501
|
1946
1946
|
|
1947
1947
|
Aggregate Returns which are on the specified portfolio. # noqa: E501
|
@@ -1967,7 +1967,7 @@ class PortfoliosApi:
|
|
1967
1967
|
:type from_effective_at: str
|
1968
1968
|
:param to_effective_at: The end date for which to calculate the Returns.
|
1969
1969
|
:type to_effective_at: str
|
1970
|
-
:param composite_method: The method used to calculate the Portfolio performance:
|
1970
|
+
:param composite_method: The method used to calculate the Portfolio performance: Equal/Asset.
|
1971
1971
|
:type composite_method: str
|
1972
1972
|
:param period: The type of the returns used to calculate the aggregation result: Daily/Monthly.
|
1973
1973
|
:type period: str
|
@@ -1998,7 +1998,7 @@ class PortfoliosApi:
|
|
1998
1998
|
return self.get_portfolio_aggregate_returns_with_http_info(scope, code, return_scope, return_code, recipe_id_scope, recipe_id_code, from_effective_at, to_effective_at, composite_method, period, output_frequency, metrics, as_at, alternative_inc_date, **kwargs) # noqa: E501
|
1999
1999
|
|
2000
2000
|
@validate_arguments
|
2001
|
-
def get_portfolio_aggregate_returns_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], return_scope : Annotated[StrictStr, Field(..., description="The scope of the Returns.")], return_code : Annotated[StrictStr, Field(..., description="The code of the Returns.")], recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The Recipe Scope for getting the fx rates")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The Recipe Code for getting the fx rates")] = None, from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date for which to calculate the Returns.")] = None, composite_method : Annotated[Optional[StrictStr], Field( description="The method used to calculate the Portfolio performance:
|
2001
|
+
def get_portfolio_aggregate_returns_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], return_scope : Annotated[StrictStr, Field(..., description="The scope of the Returns.")], return_code : Annotated[StrictStr, Field(..., description="The code of the Returns.")], recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The Recipe Scope for getting the fx rates")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The Recipe Code for getting the fx rates")] = None, from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date for which to calculate the Returns.")] = None, composite_method : Annotated[Optional[StrictStr], Field( description="The method used to calculate the Portfolio performance: Equal/Asset.")] = None, period : Annotated[Optional[StrictStr], Field( description="The type of the returns used to calculate the aggregation result: Daily/Monthly.")] = None, output_frequency : Annotated[Optional[StrictStr], Field( description="The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.")] = None, metrics : Annotated[Optional[conlist(StrictStr)], Field(description="Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, alternative_inc_date : Annotated[Optional[StrictStr], Field( description="The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2002
2002
|
"""[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). # noqa: E501
|
2003
2003
|
|
2004
2004
|
Aggregate Returns which are on the specified portfolio. # noqa: E501
|
@@ -2024,7 +2024,7 @@ class PortfoliosApi:
|
|
2024
2024
|
:type from_effective_at: str
|
2025
2025
|
:param to_effective_at: The end date for which to calculate the Returns.
|
2026
2026
|
:type to_effective_at: str
|
2027
|
-
:param composite_method: The method used to calculate the Portfolio performance:
|
2027
|
+
:param composite_method: The method used to calculate the Portfolio performance: Equal/Asset.
|
2028
2028
|
:type composite_method: str
|
2029
2029
|
:param period: The type of the returns used to calculate the aggregation result: Daily/Monthly.
|
2030
2030
|
:type period: str
|
@@ -2395,15 +2395,15 @@ class PortfoliosApi:
|
|
2395
2395
|
|
2396
2396
|
|
2397
2397
|
@overload
|
2398
|
-
async def get_portfolio_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], from_as_at : Annotated[Optional[datetime], Field(description="The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.")] = None, to_as_at : Annotated[Optional[datetime], Field(description="The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.
|
2398
|
+
async def get_portfolio_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], from_as_at : Annotated[Optional[datetime], Field(description="The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.")] = None, to_as_at : Annotated[Optional[datetime], Field(description="The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the User ID, specify \"userId.id eq 'string'\". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 500 if not specified.")] = None, **kwargs) -> ResourceListOfProcessedCommand: # noqa: E501
|
2399
2399
|
...
|
2400
2400
|
|
2401
2401
|
@overload
|
2402
|
-
def get_portfolio_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], from_as_at : Annotated[Optional[datetime], Field(description="The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.")] = None, to_as_at : Annotated[Optional[datetime], Field(description="The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.
|
2402
|
+
def get_portfolio_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], from_as_at : Annotated[Optional[datetime], Field(description="The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.")] = None, to_as_at : Annotated[Optional[datetime], Field(description="The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the User ID, specify \"userId.id eq 'string'\". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 500 if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfProcessedCommand: # noqa: E501
|
2403
2403
|
...
|
2404
2404
|
|
2405
2405
|
@validate_arguments
|
2406
|
-
def get_portfolio_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], from_as_at : Annotated[Optional[datetime], Field(description="The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.")] = None, to_as_at : Annotated[Optional[datetime], Field(description="The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.
|
2406
|
+
def get_portfolio_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], from_as_at : Annotated[Optional[datetime], Field(description="The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.")] = None, to_as_at : Annotated[Optional[datetime], Field(description="The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the User ID, specify \"userId.id eq 'string'\". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 500 if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfProcessedCommand, Awaitable[ResourceListOfProcessedCommand]]: # noqa: E501
|
2407
2407
|
"""GetPortfolioCommands: Get portfolio commands # noqa: E501
|
2408
2408
|
|
2409
2409
|
Get all the commands that modified a particular portfolio, including any input transactions. # noqa: E501
|
@@ -2421,7 +2421,7 @@ class PortfoliosApi:
|
|
2421
2421
|
:type from_as_at: datetime
|
2422
2422
|
:param to_as_at: The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.
|
2423
2423
|
:type to_as_at: datetime
|
2424
|
-
:param filter: Expression to filter the results.
|
2424
|
+
:param filter: Expression to filter the results. For example, to filter on the User ID, specify \"userId.id eq 'string'\". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
2425
2425
|
:type filter: str
|
2426
2426
|
:param page: The pagination token to use to continue listing commands; this value is returned from the previous call.
|
2427
2427
|
:type page: str
|
@@ -2446,7 +2446,7 @@ class PortfoliosApi:
|
|
2446
2446
|
return self.get_portfolio_commands_with_http_info(scope, code, from_as_at, to_as_at, filter, page, limit, **kwargs) # noqa: E501
|
2447
2447
|
|
2448
2448
|
@validate_arguments
|
2449
|
-
def get_portfolio_commands_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], from_as_at : Annotated[Optional[datetime], Field(description="The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.")] = None, to_as_at : Annotated[Optional[datetime], Field(description="The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.
|
2449
|
+
def get_portfolio_commands_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], from_as_at : Annotated[Optional[datetime], Field(description="The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.")] = None, to_as_at : Annotated[Optional[datetime], Field(description="The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the User ID, specify \"userId.id eq 'string'\". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 500 if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2450
2450
|
"""GetPortfolioCommands: Get portfolio commands # noqa: E501
|
2451
2451
|
|
2452
2452
|
Get all the commands that modified a particular portfolio, including any input transactions. # noqa: E501
|
@@ -2464,7 +2464,7 @@ class PortfoliosApi:
|
|
2464
2464
|
:type from_as_at: datetime
|
2465
2465
|
:param to_as_at: The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.
|
2466
2466
|
:type to_as_at: datetime
|
2467
|
-
:param filter: Expression to filter the results.
|
2467
|
+
:param filter: Expression to filter the results. For example, to filter on the User ID, specify \"userId.id eq 'string'\". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
2468
2468
|
:type filter: str
|
2469
2469
|
:param page: The pagination token to use to continue listing commands; this value is returned from the previous call.
|
2470
2470
|
:type page: str
|
@@ -2959,15 +2959,15 @@ class PortfoliosApi:
|
|
2959
2959
|
|
2960
2960
|
|
2961
2961
|
@overload
|
2962
|
-
async def get_portfolio_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show.
|
2962
|
+
async def get_portfolio_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
|
2963
2963
|
...
|
2964
2964
|
|
2965
2965
|
@overload
|
2966
|
-
def get_portfolio_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show.
|
2966
|
+
def get_portfolio_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
|
2967
2967
|
...
|
2968
2968
|
|
2969
2969
|
@validate_arguments
|
2970
|
-
def get_portfolio_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show.
|
2970
|
+
def get_portfolio_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
|
2971
2971
|
"""GetPortfolioPropertyTimeSeries: Get portfolio property time series # noqa: E501
|
2972
2972
|
|
2973
2973
|
Show the complete time series (history) for a particular portfolio property. # noqa: E501
|
@@ -2981,15 +2981,15 @@ class PortfoliosApi:
|
|
2981
2981
|
:type scope: str
|
2982
2982
|
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
2983
2983
|
:type code: str
|
2984
|
-
:param property_key: The property key of the property whose history to show.
|
2984
|
+
:param property_key: The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (required)
|
2985
2985
|
:type property_key: str
|
2986
2986
|
:param portfolio_effective_at: The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.
|
2987
2987
|
:type portfolio_effective_at: str
|
2988
2988
|
:param as_at: The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied.
|
2989
2989
|
:type as_at: datetime
|
2990
|
-
:param filter: Expression to filter the results. For more information about filtering,
|
2990
|
+
:param filter: Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
2991
2991
|
:type filter: str
|
2992
|
-
:param page: The pagination token to use to continue listing properties; this value is returned from
|
2992
|
+
:param page: The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request.
|
2993
2993
|
:type page: str
|
2994
2994
|
:param limit: When paginating, limit the results to this number.
|
2995
2995
|
:type limit: int
|
@@ -3012,7 +3012,7 @@ class PortfoliosApi:
|
|
3012
3012
|
return self.get_portfolio_property_time_series_with_http_info(scope, code, property_key, portfolio_effective_at, as_at, filter, page, limit, **kwargs) # noqa: E501
|
3013
3013
|
|
3014
3014
|
@validate_arguments
|
3015
|
-
def get_portfolio_property_time_series_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show.
|
3015
|
+
def get_portfolio_property_time_series_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3016
3016
|
"""GetPortfolioPropertyTimeSeries: Get portfolio property time series # noqa: E501
|
3017
3017
|
|
3018
3018
|
Show the complete time series (history) for a particular portfolio property. # noqa: E501
|
@@ -3026,15 +3026,15 @@ class PortfoliosApi:
|
|
3026
3026
|
:type scope: str
|
3027
3027
|
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
3028
3028
|
:type code: str
|
3029
|
-
:param property_key: The property key of the property whose history to show.
|
3029
|
+
:param property_key: The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (required)
|
3030
3030
|
:type property_key: str
|
3031
3031
|
:param portfolio_effective_at: The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.
|
3032
3032
|
:type portfolio_effective_at: str
|
3033
3033
|
:param as_at: The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied.
|
3034
3034
|
:type as_at: datetime
|
3035
|
-
:param filter: Expression to filter the results. For more information about filtering,
|
3035
|
+
:param filter: Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
3036
3036
|
:type filter: str
|
3037
|
-
:param page: The pagination token to use to continue listing properties; this value is returned from
|
3037
|
+
:param page: The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request.
|
3038
3038
|
:type page: str
|
3039
3039
|
:param limit: When paginating, limit the results to this number.
|
3040
3040
|
:type limit: int
|
@@ -3170,15 +3170,15 @@ class PortfoliosApi:
|
|
3170
3170
|
|
3171
3171
|
|
3172
3172
|
@overload
|
3173
|
-
async def get_portfolio_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3173
|
+
async def get_portfolio_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ResourceListOfRelation: # noqa: E501
|
3174
3174
|
...
|
3175
3175
|
|
3176
3176
|
@overload
|
3177
|
-
def get_portfolio_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3177
|
+
def get_portfolio_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelation: # noqa: E501
|
3178
3178
|
...
|
3179
3179
|
|
3180
3180
|
@validate_arguments
|
3181
|
-
def get_portfolio_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3181
|
+
def get_portfolio_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelation, Awaitable[ResourceListOfRelation]]: # noqa: E501
|
3182
3182
|
"""[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations # noqa: E501
|
3183
3183
|
|
3184
3184
|
Get relations for a particular portfolio. # noqa: E501
|
@@ -3198,7 +3198,7 @@ class PortfoliosApi:
|
|
3198
3198
|
:type as_at: datetime
|
3199
3199
|
:param filter: Expression to filter the relations. Provide a null or empty string for this field until further notice.
|
3200
3200
|
:type filter: str
|
3201
|
-
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3201
|
+
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array.
|
3202
3202
|
:type identifier_types: List[str]
|
3203
3203
|
:param async_req: Whether to execute the request asynchronously.
|
3204
3204
|
:type async_req: bool, optional
|
@@ -3219,7 +3219,7 @@ class PortfoliosApi:
|
|
3219
3219
|
return self.get_portfolio_relations_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
|
3220
3220
|
|
3221
3221
|
@validate_arguments
|
3222
|
-
def get_portfolio_relations_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3222
|
+
def get_portfolio_relations_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3223
3223
|
"""[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations # noqa: E501
|
3224
3224
|
|
3225
3225
|
Get relations for a particular portfolio. # noqa: E501
|
@@ -3239,7 +3239,7 @@ class PortfoliosApi:
|
|
3239
3239
|
:type as_at: datetime
|
3240
3240
|
:param filter: Expression to filter the relations. Provide a null or empty string for this field until further notice.
|
3241
3241
|
:type filter: str
|
3242
|
-
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3242
|
+
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array.
|
3243
3243
|
:type identifier_types: List[str]
|
3244
3244
|
:param async_req: Whether to execute the request asynchronously.
|
3245
3245
|
:type async_req: bool, optional
|
@@ -3366,15 +3366,15 @@ class PortfoliosApi:
|
|
3366
3366
|
|
3367
3367
|
|
3368
3368
|
@overload
|
3369
|
-
async def get_portfolio_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relationships. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3369
|
+
async def get_portfolio_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relationships. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, **kwargs) -> ResourceListOfRelationship: # noqa: E501
|
3370
3370
|
...
|
3371
3371
|
|
3372
3372
|
@overload
|
3373
|
-
def get_portfolio_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relationships. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3373
|
+
def get_portfolio_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relationships. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelationship: # noqa: E501
|
3374
3374
|
...
|
3375
3375
|
|
3376
3376
|
@validate_arguments
|
3377
|
-
def get_portfolio_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relationships. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3377
|
+
def get_portfolio_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relationships. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
|
3378
3378
|
"""GetPortfolioRelationships: Get portfolio relationships # noqa: E501
|
3379
3379
|
|
3380
3380
|
Get relationships for a particular portfolio. # noqa: E501
|
@@ -3394,7 +3394,7 @@ class PortfoliosApi:
|
|
3394
3394
|
:type as_at: datetime
|
3395
3395
|
:param filter: Expression to filter the relationships. Provide a null or empty string for this field until further notice.
|
3396
3396
|
:type filter: str
|
3397
|
-
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3397
|
+
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
|
3398
3398
|
:type identifier_types: List[str]
|
3399
3399
|
:param async_req: Whether to execute the request asynchronously.
|
3400
3400
|
:type async_req: bool, optional
|
@@ -3415,7 +3415,7 @@ class PortfoliosApi:
|
|
3415
3415
|
return self.get_portfolio_relationships_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
|
3416
3416
|
|
3417
3417
|
@validate_arguments
|
3418
|
-
def get_portfolio_relationships_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relationships. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3418
|
+
def get_portfolio_relationships_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relationships. Provide a null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3419
3419
|
"""GetPortfolioRelationships: Get portfolio relationships # noqa: E501
|
3420
3420
|
|
3421
3421
|
Get relationships for a particular portfolio. # noqa: E501
|
@@ -3435,7 +3435,7 @@ class PortfoliosApi:
|
|
3435
3435
|
:type as_at: datetime
|
3436
3436
|
:param filter: Expression to filter the relationships. Provide a null or empty string for this field until further notice.
|
3437
3437
|
:type filter: str
|
3438
|
-
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3438
|
+
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
|
3439
3439
|
:type identifier_types: List[str]
|
3440
3440
|
:param async_req: Whether to execute the request asynchronously.
|
3441
3441
|
:type async_req: bool, optional
|
@@ -3784,7 +3784,7 @@ class PortfoliosApi:
|
|
3784
3784
|
def get_portfolios_access_metadata_by_key(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata to retrieve")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the rule")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio access metadata.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[List[AccessMetadataValue], Awaitable[List[AccessMetadataValue]]]: # noqa: E501
|
3785
3785
|
"""[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object # noqa: E501
|
3786
3786
|
|
3787
|
-
Get a specific portfolio access metadata rule by specifying the corresponding identifier parts
|
3787
|
+
Get a specific portfolio access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule # noqa: E501
|
3788
3788
|
This method makes a synchronous HTTP request by default. To make an
|
3789
3789
|
asynchronous HTTP request, please pass async_req=True
|
3790
3790
|
|
@@ -3823,7 +3823,7 @@ class PortfoliosApi:
|
|
3823
3823
|
def get_portfolios_access_metadata_by_key_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata to retrieve")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the rule")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio access metadata.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3824
3824
|
"""[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object # noqa: E501
|
3825
3825
|
|
3826
|
-
Get a specific portfolio access metadata rule by specifying the corresponding identifier parts
|
3826
|
+
Get a specific portfolio access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule # noqa: E501
|
3827
3827
|
This method makes a synchronous HTTP request by default. To make an
|
3828
3828
|
asynchronous HTTP request, please pass async_req=True
|
3829
3829
|
|
@@ -3960,15 +3960,15 @@ class PortfoliosApi:
|
|
3960
3960
|
|
3961
3961
|
|
3962
3962
|
@overload
|
3963
|
-
async def list_instrument_event_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; this value is returned from the previous call.
|
3963
|
+
async def list_instrument_event_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> PagedResourceListOfInstrumentEventInstruction: # noqa: E501
|
3964
3964
|
...
|
3965
3965
|
|
3966
3966
|
@overload
|
3967
|
-
def list_instrument_event_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; this value is returned from the previous call.
|
3967
|
+
def list_instrument_event_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfInstrumentEventInstruction: # noqa: E501
|
3968
3968
|
...
|
3969
3969
|
|
3970
3970
|
@validate_arguments
|
3971
|
-
def list_instrument_event_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; this value is returned from the previous call.
|
3971
|
+
def list_instrument_event_instructions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfInstrumentEventInstruction, Awaitable[PagedResourceListOfInstrumentEventInstruction]]: # noqa: E501
|
3972
3972
|
"""[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions # noqa: E501
|
3973
3973
|
|
3974
3974
|
Lists all instructions for a particular portfolio # noqa: E501
|
@@ -3986,11 +3986,11 @@ class PortfoliosApi:
|
|
3986
3986
|
:type portfolio_effective_at: str
|
3987
3987
|
:param as_at: The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.
|
3988
3988
|
:type as_at: datetime
|
3989
|
-
:param page: The pagination token to use to continue listing instructions; this value is returned from the previous call.
|
3989
|
+
:param page: The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
3990
3990
|
:type page: str
|
3991
3991
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
3992
3992
|
:type limit: int
|
3993
|
-
:param filter: Expression to filter the results. For more information about filtering
|
3993
|
+
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
3994
3994
|
:type filter: str
|
3995
3995
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3996
3996
|
:type sort_by: List[str]
|
@@ -4013,7 +4013,7 @@ class PortfoliosApi:
|
|
4013
4013
|
return self.list_instrument_event_instructions_with_http_info(scope, code, portfolio_effective_at, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
4014
4014
|
|
4015
4015
|
@validate_arguments
|
4016
|
-
def list_instrument_event_instructions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; this value is returned from the previous call.
|
4016
|
+
def list_instrument_event_instructions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field( description="The effective date at which the portfolio will be resolved. Defaults to current time if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4017
4017
|
"""[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions # noqa: E501
|
4018
4018
|
|
4019
4019
|
Lists all instructions for a particular portfolio # noqa: E501
|
@@ -4031,11 +4031,11 @@ class PortfoliosApi:
|
|
4031
4031
|
:type portfolio_effective_at: str
|
4032
4032
|
:param as_at: The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified.
|
4033
4033
|
:type as_at: datetime
|
4034
|
-
:param page: The pagination token to use to continue listing instructions; this value is returned from the previous call.
|
4034
|
+
:param page: The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
4035
4035
|
:type page: str
|
4036
4036
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
4037
4037
|
:type limit: int
|
4038
|
-
:param filter: Expression to filter the results. For more information about filtering
|
4038
|
+
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4039
4039
|
:type filter: str
|
4040
4040
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
4041
4041
|
:type sort_by: List[str]
|
@@ -4367,15 +4367,15 @@ class PortfoliosApi:
|
|
4367
4367
|
|
4368
4368
|
|
4369
4369
|
@overload
|
4370
|
-
async def list_portfolios(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4370
|
+
async def list_portfolios(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the transaction type, specify \"type eq 'Transaction'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, query : Annotated[Optional[StrictStr], Field( description="Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify \"instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ResourceListOfPortfolio: # noqa: E501
|
4371
4371
|
...
|
4372
4372
|
|
4373
4373
|
@overload
|
4374
|
-
def list_portfolios(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4374
|
+
def list_portfolios(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the transaction type, specify \"type eq 'Transaction'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, query : Annotated[Optional[StrictStr], Field( description="Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify \"instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPortfolio: # noqa: E501
|
4375
4375
|
...
|
4376
4376
|
|
4377
4377
|
@validate_arguments
|
4378
|
-
def list_portfolios(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4378
|
+
def list_portfolios(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the transaction type, specify \"type eq 'Transaction'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, query : Annotated[Optional[StrictStr], Field( description="Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify \"instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPortfolio, Awaitable[ResourceListOfPortfolio]]: # noqa: E501
|
4379
4379
|
"""ListPortfolios: List portfolios # noqa: E501
|
4380
4380
|
|
4381
4381
|
List all the portfolios matching particular criteria. # noqa: E501
|
@@ -4385,23 +4385,23 @@ class PortfoliosApi:
|
|
4385
4385
|
>>> thread = api.list_portfolios(effective_at, as_at, page, limit, filter, sort_by, query, property_keys, relationship_definition_ids, async_req=True)
|
4386
4386
|
>>> result = thread.get()
|
4387
4387
|
|
4388
|
-
:param effective_at: The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4388
|
+
:param effective_at: The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.
|
4389
4389
|
:type effective_at: str
|
4390
|
-
:param as_at: The asAt datetime at which to list the portfolios. Defaults to returning the latest version
|
4390
|
+
:param as_at: The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.
|
4391
4391
|
:type as_at: datetime
|
4392
|
-
:param page: The pagination token to use to continue listing portfolios; this
|
4392
|
+
:param page: The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
4393
4393
|
:type page: str
|
4394
4394
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
4395
4395
|
:type limit: int
|
4396
|
-
:param filter: Expression to filter the results.
|
4396
|
+
:param filter: Expression to filter the results. For example, to filter on the transaction type, specify \"type eq 'Transaction'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4397
4397
|
:type filter: str
|
4398
4398
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
4399
4399
|
:type sort_by: List[str]
|
4400
|
-
:param query: Expression specifying the criteria that the returned portfolios must meet. For example, to see which
|
4400
|
+
:param query: Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify \"instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))\".
|
4401
4401
|
:type query: str
|
4402
|
-
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto each portfolio,
|
4402
|
+
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
4403
4403
|
:type property_keys: List[str]
|
4404
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
4404
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
4405
4405
|
:type relationship_definition_ids: List[str]
|
4406
4406
|
:param async_req: Whether to execute the request asynchronously.
|
4407
4407
|
:type async_req: bool, optional
|
@@ -4422,7 +4422,7 @@ class PortfoliosApi:
|
|
4422
4422
|
return self.list_portfolios_with_http_info(effective_at, as_at, page, limit, filter, sort_by, query, property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
4423
4423
|
|
4424
4424
|
@validate_arguments
|
4425
|
-
def list_portfolios_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4425
|
+
def list_portfolios_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the transaction type, specify \"type eq 'Transaction'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, query : Annotated[Optional[StrictStr], Field( description="Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify \"instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4426
4426
|
"""ListPortfolios: List portfolios # noqa: E501
|
4427
4427
|
|
4428
4428
|
List all the portfolios matching particular criteria. # noqa: E501
|
@@ -4432,23 +4432,23 @@ class PortfoliosApi:
|
|
4432
4432
|
>>> thread = api.list_portfolios_with_http_info(effective_at, as_at, page, limit, filter, sort_by, query, property_keys, relationship_definition_ids, async_req=True)
|
4433
4433
|
>>> result = thread.get()
|
4434
4434
|
|
4435
|
-
:param effective_at: The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4435
|
+
:param effective_at: The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.
|
4436
4436
|
:type effective_at: str
|
4437
|
-
:param as_at: The asAt datetime at which to list the portfolios. Defaults to returning the latest version
|
4437
|
+
:param as_at: The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.
|
4438
4438
|
:type as_at: datetime
|
4439
|
-
:param page: The pagination token to use to continue listing portfolios; this
|
4439
|
+
:param page: The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
4440
4440
|
:type page: str
|
4441
4441
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
4442
4442
|
:type limit: int
|
4443
|
-
:param filter: Expression to filter the results.
|
4443
|
+
:param filter: Expression to filter the results. For example, to filter on the transaction type, specify \"type eq 'Transaction'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4444
4444
|
:type filter: str
|
4445
4445
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
4446
4446
|
:type sort_by: List[str]
|
4447
|
-
:param query: Expression specifying the criteria that the returned portfolios must meet. For example, to see which
|
4447
|
+
:param query: Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify \"instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))\".
|
4448
4448
|
:type query: str
|
4449
|
-
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto each portfolio,
|
4449
|
+
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
4450
4450
|
:type property_keys: List[str]
|
4451
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
4451
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
4452
4452
|
:type relationship_definition_ids: List[str]
|
4453
4453
|
:param async_req: Whether to execute the request asynchronously.
|
4454
4454
|
:type async_req: bool, optional
|
@@ -4589,15 +4589,15 @@ class PortfoliosApi:
|
|
4589
4589
|
|
4590
4590
|
|
4591
4591
|
@overload
|
4592
|
-
async def list_portfolios_for_scope(self, scope : Annotated[StrictStr, Field(..., description="The scope whose portfolios to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4592
|
+
async def list_portfolios_for_scope(self, scope : Annotated[StrictStr, Field(..., description="The scope whose portfolios to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ResourceListOfPortfolio: # noqa: E501
|
4593
4593
|
...
|
4594
4594
|
|
4595
4595
|
@overload
|
4596
|
-
def list_portfolios_for_scope(self, scope : Annotated[StrictStr, Field(..., description="The scope whose portfolios to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4596
|
+
def list_portfolios_for_scope(self, scope : Annotated[StrictStr, Field(..., description="The scope whose portfolios to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPortfolio: # noqa: E501
|
4597
4597
|
...
|
4598
4598
|
|
4599
4599
|
@validate_arguments
|
4600
|
-
def list_portfolios_for_scope(self, scope : Annotated[StrictStr, Field(..., description="The scope whose portfolios to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4600
|
+
def list_portfolios_for_scope(self, scope : Annotated[StrictStr, Field(..., description="The scope whose portfolios to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPortfolio, Awaitable[ResourceListOfPortfolio]]: # noqa: E501
|
4601
4601
|
"""ListPortfoliosForScope: List portfolios for scope # noqa: E501
|
4602
4602
|
|
4603
4603
|
List all the portfolios in a particular scope. # noqa: E501
|
@@ -4609,21 +4609,21 @@ class PortfoliosApi:
|
|
4609
4609
|
|
4610
4610
|
:param scope: The scope whose portfolios to list. (required)
|
4611
4611
|
:type scope: str
|
4612
|
-
:param effective_at: The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4612
|
+
:param effective_at: The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.
|
4613
4613
|
:type effective_at: str
|
4614
|
-
:param as_at: The asAt datetime at which to list the portfolios. Defaults to returning the latest version
|
4614
|
+
:param as_at: The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.
|
4615
4615
|
:type as_at: datetime
|
4616
|
-
:param page: The pagination token to use to continue listing portfolios. This
|
4616
|
+
:param page: The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
4617
4617
|
:type page: str
|
4618
4618
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
4619
4619
|
:type limit: int
|
4620
|
-
:param filter: Expression to filter the results.
|
4620
|
+
:param filter: Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4621
4621
|
:type filter: str
|
4622
4622
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
4623
4623
|
:type sort_by: List[str]
|
4624
|
-
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto each portfolio,
|
4624
|
+
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
4625
4625
|
:type property_keys: List[str]
|
4626
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
4626
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
4627
4627
|
:type relationship_definition_ids: List[str]
|
4628
4628
|
:param async_req: Whether to execute the request asynchronously.
|
4629
4629
|
:type async_req: bool, optional
|
@@ -4644,7 +4644,7 @@ class PortfoliosApi:
|
|
4644
4644
|
return self.list_portfolios_for_scope_with_http_info(scope, effective_at, as_at, page, limit, filter, sort_by, property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
4645
4645
|
|
4646
4646
|
@validate_arguments
|
4647
|
-
def list_portfolios_for_scope_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope whose portfolios to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4647
|
+
def list_portfolios_for_scope_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope whose portfolios to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4648
4648
|
"""ListPortfoliosForScope: List portfolios for scope # noqa: E501
|
4649
4649
|
|
4650
4650
|
List all the portfolios in a particular scope. # noqa: E501
|
@@ -4656,21 +4656,21 @@ class PortfoliosApi:
|
|
4656
4656
|
|
4657
4657
|
:param scope: The scope whose portfolios to list. (required)
|
4658
4658
|
:type scope: str
|
4659
|
-
:param effective_at: The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID
|
4659
|
+
:param effective_at: The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified.
|
4660
4660
|
:type effective_at: str
|
4661
|
-
:param as_at: The asAt datetime at which to list the portfolios. Defaults to returning the latest version
|
4661
|
+
:param as_at: The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.
|
4662
4662
|
:type as_at: datetime
|
4663
|
-
:param page: The pagination token to use to continue listing portfolios. This
|
4663
|
+
:param page: The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
4664
4664
|
:type page: str
|
4665
4665
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
4666
4666
|
:type limit: int
|
4667
|
-
:param filter: Expression to filter the results.
|
4667
|
+
:param filter: Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
4668
4668
|
:type filter: str
|
4669
4669
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
4670
4670
|
:type sort_by: List[str]
|
4671
|
-
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto each portfolio,
|
4671
|
+
:param property_keys: A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
4672
4672
|
:type property_keys: List[str]
|
4673
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
4673
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
4674
4674
|
:type relationship_definition_ids: List[str]
|
4675
4675
|
:param async_req: Whether to execute the request asynchronously.
|
4676
4676
|
:type async_req: bool, optional
|
@@ -4811,15 +4811,15 @@ class PortfoliosApi:
|
|
4811
4811
|
|
4812
4812
|
|
4813
4813
|
@overload
|
4814
|
-
async def patch_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the
|
4814
|
+
async def patch_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.")], **kwargs) -> Portfolio: # noqa: E501
|
4815
4815
|
...
|
4816
4816
|
|
4817
4817
|
@overload
|
4818
|
-
def patch_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the
|
4818
|
+
def patch_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.")], async_req: Optional[bool]=True, **kwargs) -> Portfolio: # noqa: E501
|
4819
4819
|
...
|
4820
4820
|
|
4821
4821
|
@validate_arguments
|
4822
|
-
def patch_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the
|
4822
|
+
def patch_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.")], async_req: Optional[bool]=None, **kwargs) -> Union[Portfolio, Awaitable[Portfolio]]: # noqa: E501
|
4823
4823
|
"""PatchPortfolio: Patch portfolio. # noqa: E501
|
4824
4824
|
|
4825
4825
|
Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported fields are: Created, InstrumentScopes, Type. # noqa: E501
|
@@ -4831,7 +4831,7 @@ class PortfoliosApi:
|
|
4831
4831
|
|
4832
4832
|
:param scope: The scope of the portfolio. (required)
|
4833
4833
|
:type scope: str
|
4834
|
-
:param code: The code of the portfolio. Together with the
|
4834
|
+
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
4835
4835
|
:type code: str
|
4836
4836
|
:param operation: The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902. (required)
|
4837
4837
|
:type operation: List[Operation]
|
@@ -4854,7 +4854,7 @@ class PortfoliosApi:
|
|
4854
4854
|
return self.patch_portfolio_with_http_info(scope, code, operation, **kwargs) # noqa: E501
|
4855
4855
|
|
4856
4856
|
@validate_arguments
|
4857
|
-
def patch_portfolio_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the
|
4857
|
+
def patch_portfolio_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.")], **kwargs) -> ApiResponse: # noqa: E501
|
4858
4858
|
"""PatchPortfolio: Patch portfolio. # noqa: E501
|
4859
4859
|
|
4860
4860
|
Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported fields are: Created, InstrumentScopes, Type. # noqa: E501
|
@@ -4866,7 +4866,7 @@ class PortfoliosApi:
|
|
4866
4866
|
|
4867
4867
|
:param scope: The scope of the portfolio. (required)
|
4868
4868
|
:type scope: str
|
4869
|
-
:param code: The code of the portfolio. Together with the
|
4869
|
+
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
4870
4870
|
:type code: str
|
4871
4871
|
:param operation: The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902. (required)
|
4872
4872
|
:type operation: List[Operation]
|
@@ -4997,7 +4997,7 @@ class PortfoliosApi:
|
|
4997
4997
|
def patch_portfolio_access_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Access Metadata Rule.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field( description="The date this rule will effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[AccessMetadataValue]], Awaitable[Dict[str, List[AccessMetadataValue]]]]: # noqa: E501
|
4998
4998
|
"""[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. # noqa: E501
|
4999
4999
|
|
5000
|
-
Patch Portfolio Access Metadata Rules in a single scope.
|
5000
|
+
Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
5001
5001
|
This method makes a synchronous HTTP request by default. To make an
|
5002
5002
|
asynchronous HTTP request, please pass async_req=True
|
5003
5003
|
|
@@ -5036,7 +5036,7 @@ class PortfoliosApi:
|
|
5036
5036
|
def patch_portfolio_access_metadata_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Access Metadata Rule.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field( description="The date this rule will effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5037
5037
|
"""[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. # noqa: E501
|
5038
5038
|
|
5039
|
-
Patch Portfolio Access Metadata Rules in a single scope.
|
5039
|
+
Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
5040
5040
|
This method makes a synchronous HTTP request by default. To make an
|
5041
5041
|
asynchronous HTTP request, please pass async_req=True
|
5042
5042
|
|
@@ -5180,18 +5180,18 @@ class PortfoliosApi:
|
|
5180
5180
|
|
5181
5181
|
|
5182
5182
|
@overload
|
5183
|
-
async def update_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], update_portfolio_request : Annotated[UpdatePortfolioRequest, Field(..., description="The updated portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition. Defaults to the current
|
5183
|
+
async def update_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], update_portfolio_request : Annotated[UpdatePortfolioRequest, Field(..., description="The updated portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> Portfolio: # noqa: E501
|
5184
5184
|
...
|
5185
5185
|
|
5186
5186
|
@overload
|
5187
|
-
def update_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], update_portfolio_request : Annotated[UpdatePortfolioRequest, Field(..., description="The updated portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition. Defaults to the current
|
5187
|
+
def update_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], update_portfolio_request : Annotated[UpdatePortfolioRequest, Field(..., description="The updated portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> Portfolio: # noqa: E501
|
5188
5188
|
...
|
5189
5189
|
|
5190
5190
|
@validate_arguments
|
5191
|
-
def update_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], update_portfolio_request : Annotated[UpdatePortfolioRequest, Field(..., description="The updated portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition. Defaults to the current
|
5191
|
+
def update_portfolio(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], update_portfolio_request : Annotated[UpdatePortfolioRequest, Field(..., description="The updated portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Portfolio, Awaitable[Portfolio]]: # noqa: E501
|
5192
5192
|
"""UpdatePortfolio: Update portfolio # noqa: E501
|
5193
5193
|
|
5194
|
-
Update the definition of a particular portfolio.
|
5194
|
+
Update the definition of a particular portfolio. Note that not all elements of a portfolio definition are modifiable due to the potential implications for data already stored. # noqa: E501
|
5195
5195
|
This method makes a synchronous HTTP request by default. To make an
|
5196
5196
|
asynchronous HTTP request, please pass async_req=True
|
5197
5197
|
|
@@ -5204,7 +5204,7 @@ class PortfoliosApi:
|
|
5204
5204
|
:type code: str
|
5205
5205
|
:param update_portfolio_request: The updated portfolio definition. (required)
|
5206
5206
|
:type update_portfolio_request: UpdatePortfolioRequest
|
5207
|
-
:param effective_at: The effective datetime or cut label at which to update the definition. Defaults to the current
|
5207
|
+
:param effective_at: The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified.
|
5208
5208
|
:type effective_at: str
|
5209
5209
|
:param async_req: Whether to execute the request asynchronously.
|
5210
5210
|
:type async_req: bool, optional
|
@@ -5225,10 +5225,10 @@ class PortfoliosApi:
|
|
5225
5225
|
return self.update_portfolio_with_http_info(scope, code, update_portfolio_request, effective_at, **kwargs) # noqa: E501
|
5226
5226
|
|
5227
5227
|
@validate_arguments
|
5228
|
-
def update_portfolio_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], update_portfolio_request : Annotated[UpdatePortfolioRequest, Field(..., description="The updated portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition. Defaults to the current
|
5228
|
+
def update_portfolio_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], update_portfolio_request : Annotated[UpdatePortfolioRequest, Field(..., description="The updated portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5229
5229
|
"""UpdatePortfolio: Update portfolio # noqa: E501
|
5230
5230
|
|
5231
|
-
Update the definition of a particular portfolio.
|
5231
|
+
Update the definition of a particular portfolio. Note that not all elements of a portfolio definition are modifiable due to the potential implications for data already stored. # noqa: E501
|
5232
5232
|
This method makes a synchronous HTTP request by default. To make an
|
5233
5233
|
asynchronous HTTP request, please pass async_req=True
|
5234
5234
|
|
@@ -5241,7 +5241,7 @@ class PortfoliosApi:
|
|
5241
5241
|
:type code: str
|
5242
5242
|
:param update_portfolio_request: The updated portfolio definition. (required)
|
5243
5243
|
:type update_portfolio_request: UpdatePortfolioRequest
|
5244
|
-
:param effective_at: The effective datetime or cut label at which to update the definition. Defaults to the current
|
5244
|
+
:param effective_at: The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified.
|
5245
5245
|
:type effective_at: str
|
5246
5246
|
:param async_req: Whether to execute the request asynchronously.
|
5247
5247
|
:type async_req: bool, optional
|
@@ -5565,7 +5565,7 @@ class PortfoliosApi:
|
|
5565
5565
|
def upsert_portfolio_access_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope to use when updating or inserting the Portfolio Access Metadata Rule.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the access metadata to upsert")], upsert_portfolio_access_metadata_request : Annotated[UpsertPortfolioAccessMetadataRequest, Field(..., description="The Portfolio Access Metadata Rule to update or insert")], effective_at : Annotated[Optional[StrictStr], Field( description="The date this rule will effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAccessMetadataValueOf, Awaitable[ResourceListOfAccessMetadataValueOf]]: # noqa: E501
|
5566
5566
|
"""UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
5567
5567
|
|
5568
|
-
Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists
|
5568
|
+
Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Portfolio Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched # noqa: E501
|
5569
5569
|
This method makes a synchronous HTTP request by default. To make an
|
5570
5570
|
asynchronous HTTP request, please pass async_req=True
|
5571
5571
|
|
@@ -5606,7 +5606,7 @@ class PortfoliosApi:
|
|
5606
5606
|
def upsert_portfolio_access_metadata_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to use when updating or inserting the Portfolio Access Metadata Rule.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the access metadata to upsert")], upsert_portfolio_access_metadata_request : Annotated[UpsertPortfolioAccessMetadataRequest, Field(..., description="The Portfolio Access Metadata Rule to update or insert")], effective_at : Annotated[Optional[StrictStr], Field( description="The date this rule will effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
5607
5607
|
"""UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
5608
5608
|
|
5609
|
-
Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists
|
5609
|
+
Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Portfolio Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched # noqa: E501
|
5610
5610
|
This method makes a synchronous HTTP request by default. To make an
|
5611
5611
|
asynchronous HTTP request, please pass async_req=True
|
5612
5612
|
|
@@ -5756,18 +5756,18 @@ class PortfoliosApi:
|
|
5756
5756
|
|
5757
5757
|
|
5758
5758
|
@overload
|
5759
|
-
async def upsert_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in
|
5759
|
+
async def upsert_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], **kwargs) -> PortfolioProperties: # noqa: E501
|
5760
5760
|
...
|
5761
5761
|
|
5762
5762
|
@overload
|
5763
|
-
def upsert_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in
|
5763
|
+
def upsert_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], async_req: Optional[bool]=True, **kwargs) -> PortfolioProperties: # noqa: E501
|
5764
5764
|
...
|
5765
5765
|
|
5766
5766
|
@validate_arguments
|
5767
|
-
def upsert_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in
|
5767
|
+
def upsert_portfolio_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioProperties, Awaitable[PortfolioProperties]]: # noqa: E501
|
5768
5768
|
"""UpsertPortfolioProperties: Upsert portfolio properties # noqa: E501
|
5769
5769
|
|
5770
|
-
Create or update one or more properties for a particular portfolio. A property is updated if it
|
5770
|
+
Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the 'Portfolio' domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
5771
5771
|
This method makes a synchronous HTTP request by default. To make an
|
5772
5772
|
asynchronous HTTP request, please pass async_req=True
|
5773
5773
|
|
@@ -5778,7 +5778,7 @@ class PortfoliosApi:
|
|
5778
5778
|
:type scope: str
|
5779
5779
|
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
5780
5780
|
:type code: str
|
5781
|
-
:param request_body: The properties to be created or updated. Each property in
|
5781
|
+
:param request_body: The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (required)
|
5782
5782
|
:type request_body: Dict[str, ModelProperty]
|
5783
5783
|
:param async_req: Whether to execute the request asynchronously.
|
5784
5784
|
:type async_req: bool, optional
|
@@ -5799,10 +5799,10 @@ class PortfoliosApi:
|
|
5799
5799
|
return self.upsert_portfolio_properties_with_http_info(scope, code, request_body, **kwargs) # noqa: E501
|
5800
5800
|
|
5801
5801
|
@validate_arguments
|
5802
|
-
def upsert_portfolio_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in
|
5802
|
+
def upsert_portfolio_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], **kwargs) -> ApiResponse: # noqa: E501
|
5803
5803
|
"""UpsertPortfolioProperties: Upsert portfolio properties # noqa: E501
|
5804
5804
|
|
5805
|
-
Create or update one or more properties for a particular portfolio. A property is updated if it
|
5805
|
+
Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the 'Portfolio' domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
5806
5806
|
This method makes a synchronous HTTP request by default. To make an
|
5807
5807
|
asynchronous HTTP request, please pass async_req=True
|
5808
5808
|
|
@@ -5813,7 +5813,7 @@ class PortfoliosApi:
|
|
5813
5813
|
:type scope: str
|
5814
5814
|
:param code: The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)
|
5815
5815
|
:type code: str
|
5816
|
-
:param request_body: The properties to be created or updated. Each property in
|
5816
|
+
:param request_body: The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (required)
|
5817
5817
|
:type request_body: Dict[str, ModelProperty]
|
5818
5818
|
:param async_req: Whether to execute the request asynchronously.
|
5819
5819
|
:type async_req: bool, optional
|