lusid-sdk 2.1.721__py3-none-any.whl → 2.1.723__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 +74 -56
- lusid/api/abor_configuration_api.py +34 -24
- lusid/api/address_key_definition_api.py +11 -4
- lusid/api/aggregation_api.py +16 -8
- lusid/api/allocations_api.py +20 -12
- lusid/api/amortisation_rule_sets_api.py +34 -24
- lusid/api/application_metadata_api.py +15 -8
- lusid/api/blocks_api.py +20 -12
- lusid/api/calendars_api.py +70 -52
- lusid/api/chart_of_accounts_api.py +174 -136
- lusid/api/complex_market_data_api.py +20 -12
- lusid/api/compliance_api.py +71 -52
- lusid/api/configuration_recipe_api.py +47 -32
- lusid/api/conventions_api.py +40 -24
- lusid/api/corporate_action_sources_api.py +45 -32
- lusid/api/counterparties_api.py +28 -16
- lusid/api/custom_data_models_api.py +30 -20
- lusid/api/custom_entities_api.py +59 -44
- lusid/api/custom_entity_definitions_api.py +20 -12
- lusid/api/custom_entity_types_api.py +20 -12
- lusid/api/cut_label_definitions_api.py +25 -16
- lusid/api/data_types_api.py +45 -32
- lusid/api/derived_transaction_portfolios_api.py +14 -8
- lusid/api/entities_api.py +39 -28
- lusid/api/executions_api.py +20 -12
- lusid/api/fee_types_api.py +30 -20
- lusid/api/fund_configuration_api.py +34 -24
- lusid/api/funds_api.py +129 -100
- lusid/api/group_reconciliations_api.py +66 -48
- lusid/api/identifier_definitions_api.py +25 -16
- lusid/api/instrument_event_types_api.py +35 -24
- lusid/api/instrument_events_api.py +25 -16
- lusid/api/instruments_api.py +105 -80
- lusid/api/legacy_compliance_api.py +44 -32
- lusid/api/legal_entities_api.py +90 -68
- lusid/api/order_graph_api.py +19 -12
- lusid/api/order_instructions_api.py +20 -12
- lusid/api/order_management_api.py +23 -8
- lusid/api/orders_api.py +20 -12
- lusid/api/packages_api.py +20 -12
- lusid/api/participations_api.py +20 -12
- lusid/api/persons_api.py +90 -68
- lusid/api/placements_api.py +20 -12
- lusid/api/portfolio_groups_api.py +134 -104
- lusid/api/portfolios_api.py +159 -124
- lusid/api/property_definitions_api.py +51 -36
- lusid/api/queryable_keys_api.py +9 -4
- lusid/api/quotes_api.py +49 -36
- lusid/api/reconciliations_api.py +55 -36
- lusid/api/reference_lists_api.py +20 -12
- lusid/api/reference_portfolio_api.py +29 -20
- lusid/api/relation_definitions_api.py +15 -8
- lusid/api/relations_api.py +14 -8
- lusid/api/relationship_definitions_api.py +25 -16
- lusid/api/relationships_api.py +14 -8
- lusid/api/schemas_api.py +12 -4
- lusid/api/scopes_api.py +14 -8
- lusid/api/scripted_translation_api.py +28 -16
- lusid/api/search_api.py +24 -16
- lusid/api/sequences_api.py +24 -16
- lusid/api/simple_position_portfolios_api.py +9 -4
- lusid/api/staged_modifications_api.py +24 -16
- lusid/api/staging_rule_set_api.py +29 -20
- lusid/api/structured_result_data_api.py +49 -36
- lusid/api/system_configuration_api.py +23 -12
- lusid/api/tax_rule_sets_api.py +29 -20
- lusid/api/timelines_api.py +35 -24
- lusid/api/transaction_configuration_api.py +59 -44
- lusid/api/transaction_fees_api.py +29 -20
- lusid/api/transaction_portfolios_api.py +204 -160
- lusid/api/translation_api.py +6 -0
- lusid/api/workspace_api.py +96 -72
- lusid/configuration.py +1 -1
- lusid/models/a2_b_breakdown.py +2 -2
- lusid/models/a2_b_category.py +1 -1
- lusid/models/a2_b_data_record.py +7 -7
- lusid/models/a2_b_movement_record.py +8 -8
- lusid/models/abor.py +5 -5
- lusid/models/abor_configuration.py +4 -4
- lusid/models/abor_configuration_properties.py +2 -2
- lusid/models/abor_configuration_request.py +4 -21
- lusid/models/abor_properties.py +2 -2
- lusid/models/abor_request.py +4 -21
- lusid/models/accept_estimate_valuation_point_response.py +2 -2
- lusid/models/access_controlled_action.py +2 -2
- lusid/models/access_controlled_resource.py +4 -4
- lusid/models/access_metadata_operation.py +4 -11
- lusid/models/access_metadata_value.py +3 -3
- lusid/models/account.py +6 -23
- lusid/models/account_properties.py +2 -2
- lusid/models/accounted_transaction.py +2 -2
- lusid/models/accounts_upsert_response.py +2 -2
- lusid/models/accumulation_event.py +3 -3
- lusid/models/action_id.py +4 -4
- lusid/models/add_business_days_to_date_request.py +1 -1
- lusid/models/add_business_days_to_date_response.py +1 -1
- lusid/models/additional_payment.py +3 -3
- lusid/models/address_definition.py +6 -6
- lusid/models/address_key_compliance_parameter.py +3 -3
- lusid/models/address_key_definition.py +3 -3
- lusid/models/address_key_filter.py +3 -3
- lusid/models/address_key_list.py +2 -2
- lusid/models/address_key_list_compliance_parameter.py +2 -2
- lusid/models/address_key_option_definition.py +5 -5
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +3 -3
- lusid/models/adjust_holding_request.py +2 -2
- lusid/models/aggregate_spec.py +3 -3
- lusid/models/aggregated_return.py +2 -2
- lusid/models/aggregated_returns_dispersion_request.py +4 -14
- lusid/models/aggregated_returns_request.py +7 -7
- lusid/models/aggregated_returns_response.py +2 -2
- lusid/models/aggregated_transactions_request.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_measure_failure_detail.py +5 -5
- lusid/models/aggregation_options.py +1 -1
- lusid/models/aggregation_query.py +8 -8
- lusid/models/alias.py +3 -3
- lusid/models/allocation.py +8 -8
- lusid/models/allocation_request.py +6 -6
- lusid/models/allocation_service_run_response.py +1 -1
- lusid/models/allocation_set_request.py +1 -1
- lusid/models/amortisation_event.py +4 -4
- lusid/models/amortisation_rule.py +5 -29
- lusid/models/amortisation_rule_set.py +4 -21
- lusid/models/amount.py +1 -1
- lusid/models/annul_quotes_response.py +2 -2
- lusid/models/annul_single_structured_data_response.py +2 -2
- lusid/models/annul_structured_data_response.py +2 -2
- lusid/models/applicable_instrument_event.py +7 -7
- lusid/models/asset_leg.py +2 -2
- lusid/models/barrier.py +4 -4
- lusid/models/basket.py +3 -3
- lusid/models/basket_identifier.py +4 -4
- lusid/models/batch_adjust_holdings_response.py +1 -1
- lusid/models/batch_update_user_review_for_comparison_result_request.py +2 -2
- lusid/models/batch_update_user_review_for_comparison_result_response.py +1 -1
- lusid/models/batch_upsert_dates_for_calendar_response.py +1 -1
- lusid/models/batch_upsert_instrument_properties_response.py +1 -1
- lusid/models/batch_upsert_portfolio_access_metadata_request.py +1 -1
- lusid/models/batch_upsert_portfolio_access_metadata_response.py +1 -1
- lusid/models/batch_upsert_portfolio_access_metadata_response_item.py +1 -1
- lusid/models/batch_upsert_portfolio_transactions_response.py +1 -1
- lusid/models/batch_upsert_property_definition_properties_response.py +1 -1
- lusid/models/block.py +5 -5
- lusid/models/block_and_order_id_request.py +1 -1
- lusid/models/block_and_orders.py +1 -1
- lusid/models/block_and_orders_create_request.py +1 -1
- lusid/models/block_and_orders_request.py +4 -4
- lusid/models/block_request.py +4 -4
- lusid/models/block_set_request.py +1 -1
- lusid/models/blocked_order_request.py +3 -3
- lusid/models/bond.py +4 -4
- lusid/models/bond_conversion_entry.py +1 -1
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +3 -3
- lusid/models/bond_default_event.py +2 -2
- lusid/models/bond_principal_event.py +3 -3
- lusid/models/bonus_issue_event.py +3 -3
- lusid/models/book_transactions_request.py +1 -1
- lusid/models/book_transactions_response.py +1 -1
- lusid/models/bool_compliance_parameter.py +2 -2
- lusid/models/bool_list_compliance_parameter.py +2 -2
- lusid/models/branch_step.py +3 -3
- lusid/models/branch_step_request.py +3 -10
- lusid/models/break_code_source.py +1 -1
- lusid/models/bucketed_cash_flow_request.py +8 -18
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/bucketing_schedule.py +2 -2
- lusid/models/calculation_info.py +3 -3
- lusid/models/calendar.py +4 -4
- lusid/models/calendar_date.py +7 -7
- lusid/models/calendar_dependency.py +2 -2
- lusid/models/call_on_intermediate_securities_event.py +3 -3
- lusid/models/cancel_order_and_move_remaining_result.py +1 -1
- lusid/models/cancel_orders_and_move_remaining_request.py +1 -1
- lusid/models/cancel_orders_and_move_remaining_response.py +2 -2
- lusid/models/cancel_orders_response.py +2 -2
- lusid/models/cancel_placements_response.py +2 -2
- lusid/models/cancel_single_holding_adjustment_request.py +2 -2
- lusid/models/cancelled_order_result.py +1 -1
- lusid/models/cancelled_placement_result.py +1 -1
- lusid/models/cap_floor.py +3 -3
- lusid/models/capital_distribution_event.py +2 -2
- lusid/models/cash.py +3 -3
- lusid/models/cash_and_security_offer_election.py +3 -3
- lusid/models/cash_dependency.py +3 -3
- lusid/models/cash_dividend_event.py +2 -2
- lusid/models/cash_election.py +3 -3
- lusid/models/cash_flow_event.py +3 -3
- lusid/models/cash_flow_lineage.py +7 -7
- lusid/models/cash_flow_value.py +3 -3
- lusid/models/cash_flow_value_set.py +2 -2
- lusid/models/cash_ladder_record.py +1 -1
- lusid/models/cash_offer_election.py +3 -3
- lusid/models/cash_perpetual.py +3 -3
- lusid/models/cds_credit_event.py +2 -2
- lusid/models/cds_flow_conventions.py +9 -29
- lusid/models/cds_index.py +2 -2
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/cdx_credit_event.py +3 -3
- lusid/models/change.py +2 -2
- lusid/models/change_history.py +4 -4
- lusid/models/change_interval.py +6 -6
- lusid/models/change_interval_with_order_management_detail.py +7 -7
- lusid/models/change_item.py +4 -4
- lusid/models/chart_of_accounts.py +4 -4
- lusid/models/chart_of_accounts_properties.py +2 -2
- lusid/models/chart_of_accounts_request.py +4 -21
- lusid/models/check_step.py +3 -3
- lusid/models/check_step_request.py +3 -10
- lusid/models/cleardown_module_details.py +4 -21
- lusid/models/cleardown_module_request.py +4 -28
- lusid/models/cleardown_module_response.py +6 -16
- lusid/models/cleardown_module_rule.py +4 -25
- lusid/models/cleardown_module_rules_updated_response.py +2 -2
- lusid/models/client.py +2 -2
- lusid/models/close_event.py +2 -2
- lusid/models/close_period_diary_entry_request.py +4 -24
- lusid/models/closed_period.py +3 -3
- lusid/models/comparison_attribute_value_pair.py +3 -3
- lusid/models/complete_portfolio.py +6 -6
- lusid/models/complete_relation.py +4 -4
- lusid/models/complete_relationship.py +4 -4
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +2 -2
- lusid/models/complex_market_data_id.py +6 -6
- lusid/models/compliance_breached_order_info.py +1 -1
- lusid/models/compliance_parameter.py +2 -2
- lusid/models/compliance_rule.py +10 -20
- lusid/models/compliance_rule_breakdown.py +2 -2
- lusid/models/compliance_rule_breakdown_request.py +2 -2
- lusid/models/compliance_rule_response.py +4 -4
- lusid/models/compliance_rule_result.py +6 -6
- lusid/models/compliance_rule_result_detail.py +7 -7
- lusid/models/compliance_rule_result_portfolio_detail.py +2 -2
- lusid/models/compliance_rule_result_v2.py +2 -2
- lusid/models/compliance_rule_template.py +3 -13
- lusid/models/compliance_rule_upsert_request.py +10 -57
- lusid/models/compliance_rule_upsert_response.py +1 -1
- lusid/models/compliance_run_configuration.py +1 -1
- lusid/models/compliance_run_info.py +3 -3
- lusid/models/compliance_run_info_v2.py +3 -3
- lusid/models/compliance_step.py +2 -2
- lusid/models/compliance_step_request.py +2 -2
- lusid/models/compliance_summary_rule_result.py +3 -3
- lusid/models/compliance_summary_rule_result_request.py +3 -3
- lusid/models/compliance_template.py +2 -2
- lusid/models/compliance_template_parameter.py +4 -4
- lusid/models/compliance_template_variation.py +4 -4
- lusid/models/compliance_template_variation_dto.py +5 -22
- lusid/models/compliance_template_variation_request.py +5 -22
- lusid/models/component_filter.py +3 -17
- lusid/models/component_transaction.py +3 -3
- lusid/models/composite_breakdown.py +1 -1
- lusid/models/composite_breakdown_request.py +4 -4
- lusid/models/composite_breakdown_response.py +2 -2
- lusid/models/composite_dispersion.py +1 -1
- lusid/models/composite_dispersion_response.py +2 -2
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +4 -28
- lusid/models/constant_volatility_surface.py +4 -4
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_details.py +5 -5
- lusid/models/contract_for_difference.py +7 -7
- lusid/models/contract_initialisation_event.py +2 -2
- lusid/models/contribution_to_non_passing_rule_detail.py +2 -2
- lusid/models/corporate_action.py +3 -3
- lusid/models/corporate_action_source.py +4 -4
- lusid/models/corporate_action_transition.py +1 -1
- lusid/models/corporate_action_transition_component.py +3 -3
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/corporate_action_transition_request.py +1 -1
- lusid/models/counterparty_agreement.py +3 -3
- lusid/models/counterparty_risk_information.py +2 -9
- lusid/models/counterparty_signatory.py +2 -2
- lusid/models/create_address_key_definition_request.py +3 -3
- lusid/models/create_amortisation_rule_set_request.py +4 -28
- lusid/models/create_calendar_request.py +3 -17
- lusid/models/create_closed_period_request.py +2 -2
- lusid/models/create_compliance_template_request.py +3 -17
- lusid/models/create_corporate_action_source_request.py +5 -36
- lusid/models/create_custom_data_model_request.py +4 -28
- lusid/models/create_custom_entity_type_request.py +4 -18
- lusid/models/create_cut_label_definition_request.py +5 -22
- lusid/models/create_data_map_request.py +1 -1
- lusid/models/create_data_type_request.py +8 -36
- lusid/models/create_date_request.py +5 -36
- lusid/models/create_derived_property_definition_request.py +7 -7
- lusid/models/create_derived_transaction_portfolio_request.py +8 -42
- lusid/models/create_group_reconciliation_comparison_ruleset_request.py +3 -3
- lusid/models/create_group_reconciliation_definition_request.py +3 -3
- lusid/models/create_identifier_definition_request.py +9 -53
- lusid/models/create_portfolio_details.py +1 -1
- lusid/models/create_portfolio_group_request.py +4 -4
- lusid/models/create_property_definition_request.py +9 -9
- lusid/models/create_recipe_request.py +2 -2
- lusid/models/create_reconciliation_request.py +4 -11
- lusid/models/create_reference_portfolio_request.py +5 -5
- lusid/models/create_relation_definition_request.py +10 -10
- lusid/models/create_relation_request.py +1 -1
- lusid/models/create_relationship_definition_request.py +10 -45
- lusid/models/create_relationship_request.py +3 -23
- lusid/models/create_sequence_request.py +3 -20
- lusid/models/create_simple_position_portfolio_request.py +9 -26
- lusid/models/create_staging_rule_set_request.py +3 -3
- lusid/models/create_tax_rule_set_request.py +4 -18
- lusid/models/create_timeline_request.py +3 -3
- lusid/models/create_trade_tickets_response.py +1 -1
- lusid/models/create_transaction_portfolio_request.py +9 -19
- lusid/models/create_unit_definition.py +4 -25
- lusid/models/credit_default_swap.py +3 -3
- lusid/models/credit_premium_cash_flow_event.py +3 -3
- lusid/models/credit_rating.py +3 -17
- lusid/models/credit_spread_curve_data.py +4 -4
- lusid/models/credit_support_annex.py +5 -5
- lusid/models/currency_and_amount.py +2 -2
- lusid/models/curve_options.py +5 -5
- lusid/models/custodian_account.py +7 -7
- lusid/models/custodian_account_properties.py +2 -2
- lusid/models/custodian_account_request.py +9 -33
- lusid/models/custodian_accounts_upsert_response.py +2 -2
- lusid/models/custom_data_model.py +1 -1
- lusid/models/custom_data_model_criteria.py +2 -2
- lusid/models/custom_data_model_identifier_type_specification.py +2 -2
- lusid/models/custom_data_model_identifier_type_specification_with_display_name.py +3 -3
- lusid/models/custom_data_model_property_specification.py +2 -2
- lusid/models/custom_data_model_property_specification_with_display_name.py +3 -3
- lusid/models/custom_entity_definition.py +6 -6
- lusid/models/custom_entity_definition_request.py +4 -18
- lusid/models/custom_entity_entity.py +7 -7
- lusid/models/custom_entity_field.py +2 -2
- lusid/models/custom_entity_field_definition.py +6 -6
- lusid/models/custom_entity_id.py +4 -25
- lusid/models/custom_entity_request.py +3 -3
- lusid/models/custom_entity_response.py +5 -5
- lusid/models/custom_entity_type.py +6 -6
- lusid/models/cut_label_definition.py +6 -6
- lusid/models/cut_local_time.py +1 -1
- lusid/models/data_definition.py +5 -15
- lusid/models/data_map_key.py +3 -23
- lusid/models/data_mapping.py +1 -1
- lusid/models/data_model_membership.py +1 -1
- lusid/models/data_model_summary.py +5 -5
- lusid/models/data_scope.py +2 -2
- lusid/models/data_type.py +7 -7
- lusid/models/data_type_entity.py +7 -7
- lusid/models/data_type_summary.py +6 -6
- lusid/models/date_attributes.py +6 -56
- lusid/models/date_or_diary_entry.py +3 -13
- lusid/models/date_range.py +1 -1
- lusid/models/date_time_compliance_parameter.py +2 -2
- lusid/models/date_time_list_compliance_parameter.py +2 -2
- lusid/models/day_month.py +1 -1
- lusid/models/decimal_compliance_parameter.py +2 -2
- lusid/models/decimal_list.py +2 -2
- lusid/models/decimal_list_compliance_parameter.py +2 -2
- lusid/models/decorated_compliance_run_summary.py +1 -1
- lusid/models/delete_accounts_response.py +1 -1
- lusid/models/delete_custodian_accounts_response.py +1 -1
- lusid/models/delete_instrument_properties_response.py +1 -1
- lusid/models/delete_instrument_response.py +2 -2
- lusid/models/delete_instruments_response.py +2 -2
- lusid/models/delete_relation_request.py +1 -1
- lusid/models/delete_relationship_request.py +3 -23
- lusid/models/deleted_entity_response.py +4 -4
- lusid/models/dependency_source_filter.py +5 -5
- lusid/models/deposit_close_event.py +2 -2
- lusid/models/deposit_interest_payment_event.py +3 -3
- lusid/models/described_address_key.py +3 -3
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_id.py +7 -35
- lusid/models/dialect_schema.py +3 -3
- lusid/models/diary_entry.py +6 -16
- lusid/models/diary_entry_request.py +4 -21
- lusid/models/discount_factor_curve_data.py +3 -3
- lusid/models/discounting_dependency.py +3 -3
- lusid/models/dividend_option_event.py +2 -2
- lusid/models/dividend_reinvestment_event.py +2 -2
- lusid/models/drawdown_event.py +2 -2
- lusid/models/early_redemption_election.py +2 -2
- lusid/models/early_redemption_event.py +3 -3
- lusid/models/economic_dependency.py +2 -2
- lusid/models/economic_dependency_with_complex_market_data.py +1 -1
- lusid/models/economic_dependency_with_quote.py +1 -1
- lusid/models/effective_range.py +1 -1
- lusid/models/election_specification.py +2 -2
- lusid/models/eligibility_calculation.py +3 -3
- lusid/models/empty_model_options.py +2 -2
- lusid/models/entity_identifier.py +4 -4
- lusid/models/equity.py +3 -3
- lusid/models/equity_all_of_identifiers.py +12 -12
- lusid/models/equity_curve_by_prices_data.py +3 -3
- lusid/models/equity_curve_dependency.py +5 -5
- lusid/models/equity_model_options.py +3 -3
- lusid/models/equity_option.py +10 -10
- lusid/models/equity_swap.py +5 -5
- lusid/models/equity_vol_dependency.py +5 -5
- lusid/models/equity_vol_surface_data.py +3 -3
- lusid/models/error_detail.py +4 -4
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +1 -1
- lusid/models/exchange_traded_option.py +2 -2
- lusid/models/exchange_traded_option_contract_details.py +11 -11
- lusid/models/execution.py +7 -7
- lusid/models/execution_request.py +6 -6
- lusid/models/execution_set_request.py +1 -1
- lusid/models/exercise_event.py +2 -2
- lusid/models/exotic_instrument.py +3 -3
- lusid/models/expanded_group.py +4 -4
- lusid/models/expiry_event.py +2 -2
- lusid/models/external_fee_component_filter.py +4 -25
- lusid/models/fee.py +11 -31
- lusid/models/fee_accrual.py +3 -10
- lusid/models/fee_properties.py +2 -2
- lusid/models/fee_request.py +10 -27
- lusid/models/fee_rule.py +12 -12
- lusid/models/fee_rule_upsert_request.py +12 -32
- lusid/models/fee_rule_upsert_response.py +1 -1
- lusid/models/fee_transaction_template_specification.py +2 -2
- lusid/models/fee_type.py +4 -4
- lusid/models/fee_type_request.py +4 -21
- lusid/models/field_definition.py +3 -10
- lusid/models/field_schema.py +4 -4
- lusid/models/field_value.py +2 -9
- lusid/models/file_response.py +3 -3
- lusid/models/filter_predicate_compliance_parameter.py +3 -3
- lusid/models/filter_step.py +3 -3
- lusid/models/filter_step_request.py +3 -10
- lusid/models/fixed_leg.py +2 -2
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +4 -4
- lusid/models/flexible_deposit.py +3 -3
- lusid/models/flexible_loan.py +3 -3
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +2 -2
- lusid/models/flow_convention_name.py +4 -4
- lusid/models/flow_conventions.py +10 -30
- lusid/models/forward_rate_agreement.py +3 -3
- lusid/models/from_recipe.py +3 -3
- lusid/models/fund.py +5 -15
- lusid/models/fund_amount.py +1 -1
- lusid/models/fund_configuration.py +4 -4
- lusid/models/fund_configuration_properties.py +2 -2
- lusid/models/fund_configuration_request.py +4 -21
- lusid/models/fund_details.py +2 -2
- lusid/models/fund_id_list.py +2 -2
- lusid/models/fund_journal_entry_line.py +18 -18
- lusid/models/fund_pnl_breakdown.py +1 -1
- lusid/models/fund_previous_nav.py +1 -1
- lusid/models/fund_properties.py +2 -2
- lusid/models/fund_request.py +5 -22
- lusid/models/fund_share_class.py +7 -7
- lusid/models/fund_valuation_point_data.py +1 -1
- lusid/models/funding_leg.py +2 -2
- lusid/models/funding_leg_options.py +3 -3
- lusid/models/future.py +3 -3
- lusid/models/future_expiry_event.py +3 -3
- lusid/models/future_mark_to_market_event.py +3 -3
- lusid/models/futures_contract_details.py +12 -12
- lusid/models/fx_conventions.py +4 -4
- lusid/models/fx_dependency.py +4 -4
- lusid/models/fx_forward.py +5 -5
- lusid/models/fx_forward_curve_by_quote_reference.py +6 -6
- lusid/models/fx_forward_curve_data.py +5 -5
- lusid/models/fx_forward_model_options.py +4 -4
- lusid/models/fx_forward_pips_curve_data.py +5 -5
- lusid/models/fx_forward_settlement_event.py +5 -5
- lusid/models/fx_forward_tenor_curve_data.py +6 -6
- lusid/models/fx_forward_tenor_pips_curve_data.py +6 -6
- lusid/models/fx_forwards_dependency.py +5 -5
- lusid/models/fx_linked_notional_schedule.py +3 -3
- lusid/models/fx_option.py +6 -6
- lusid/models/fx_rate_schedule.py +3 -3
- lusid/models/fx_swap.py +3 -3
- lusid/models/fx_tenor_convention.py +2 -2
- lusid/models/fx_vol_dependency.py +5 -5
- lusid/models/fx_vol_surface_data.py +3 -3
- lusid/models/general_ledger_profile_mapping.py +2 -9
- lusid/models/general_ledger_profile_request.py +4 -28
- lusid/models/general_ledger_profile_response.py +5 -29
- lusid/models/generated_event_diagnostics.py +4 -4
- lusid/models/get_cds_flow_conventions_response.py +2 -2
- lusid/models/get_complex_market_data_response.py +2 -2
- lusid/models/get_counterparty_agreement_response.py +2 -2
- lusid/models/get_credit_support_annex_response.py +2 -2
- lusid/models/get_data_map_response.py +2 -2
- lusid/models/get_flow_conventions_response.py +2 -2
- lusid/models/get_index_convention_response.py +2 -2
- lusid/models/get_instruments_response.py +2 -2
- lusid/models/get_quotes_response.py +2 -2
- lusid/models/get_recipe_composer_response.py +2 -2
- lusid/models/get_recipe_response.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +4 -4
- lusid/models/get_structured_result_data_response.py +2 -2
- lusid/models/get_virtual_document_response.py +2 -2
- lusid/models/group_by_selector_compliance_parameter.py +3 -3
- lusid/models/group_by_step.py +3 -3
- lusid/models/group_by_step_request.py +3 -10
- lusid/models/group_calculation_compliance_parameter.py +3 -3
- lusid/models/group_filter_predicate_compliance_parameter.py +3 -3
- lusid/models/group_filter_step.py +3 -3
- lusid/models/group_filter_step_request.py +3 -10
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/group_reconciliation_aggregate_attribute_rule.py +1 -1
- lusid/models/group_reconciliation_aggregate_attribute_values.py +1 -1
- lusid/models/group_reconciliation_aggregate_comparison_rule_operand.py +3 -3
- lusid/models/group_reconciliation_comparison_result.py +7 -7
- lusid/models/group_reconciliation_comparison_rule_string_value_map.py +4 -4
- lusid/models/group_reconciliation_comparison_rule_tolerance.py +2 -2
- lusid/models/group_reconciliation_comparison_ruleset.py +4 -4
- lusid/models/group_reconciliation_core_attribute_rule.py +1 -1
- lusid/models/group_reconciliation_core_attribute_values.py +1 -1
- lusid/models/group_reconciliation_core_comparison_rule_operand.py +3 -3
- lusid/models/group_reconciliation_date_pair.py +1 -1
- lusid/models/group_reconciliation_dates.py +1 -1
- lusid/models/group_reconciliation_definition.py +4 -4
- lusid/models/group_reconciliation_definition_comparison_ruleset_ids.py +1 -1
- lusid/models/group_reconciliation_definition_currencies.py +3 -3
- lusid/models/group_reconciliation_definition_portfolio_entity_ids.py +1 -1
- lusid/models/group_reconciliation_definition_recipe_ids.py +1 -1
- lusid/models/group_reconciliation_instance_id.py +3 -3
- lusid/models/group_reconciliation_result_statuses.py +1 -1
- lusid/models/group_reconciliation_result_types.py +1 -1
- lusid/models/group_reconciliation_review_statuses.py +1 -1
- lusid/models/group_reconciliation_run_details.py +3 -3
- lusid/models/group_reconciliation_run_request.py +2 -2
- lusid/models/group_reconciliation_run_response.py +1 -1
- lusid/models/group_reconciliation_summary.py +2 -2
- lusid/models/group_reconciliation_user_review.py +1 -1
- lusid/models/group_reconciliation_user_review_add.py +4 -4
- lusid/models/group_reconciliation_user_review_break_code.py +3 -3
- lusid/models/group_reconciliation_user_review_comment.py +3 -3
- lusid/models/group_reconciliation_user_review_match_key.py +3 -3
- lusid/models/group_reconciliation_user_review_remove.py +1 -1
- lusid/models/grouped_result_of_address_key.py +1 -1
- lusid/models/holding_adjustment.py +4 -4
- lusid/models/holding_adjustment_with_date.py +4 -4
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_contributor.py +1 -1
- lusid/models/holding_ids_request.py +1 -1
- lusid/models/holding_pricing_info.py +3 -3
- lusid/models/holdings_adjustment.py +2 -2
- lusid/models/holdings_adjustment_header.py +2 -2
- lusid/models/i_unit_definition_dto.py +5 -5
- lusid/models/id_selector_definition.py +3 -3
- lusid/models/identifier_definition.py +10 -44
- lusid/models/identifier_part_schema.py +4 -4
- lusid/models/index_convention.py +8 -28
- lusid/models/index_model_options.py +3 -3
- lusid/models/index_projection_dependency.py +5 -5
- lusid/models/industry_classifier.py +3 -10
- lusid/models/inflation_fixing_dependency.py +4 -4
- lusid/models/inflation_index_conventions.py +6 -6
- lusid/models/inflation_leg.py +4 -4
- lusid/models/inflation_linked_bond.py +4 -4
- lusid/models/inflation_swap.py +2 -2
- lusid/models/informational_error_event.py +4 -4
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +2 -2
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/input_transition.py +1 -1
- lusid/models/instrument.py +8 -8
- lusid/models/instrument_capabilities.py +3 -3
- lusid/models/instrument_cash_flow.py +5 -5
- lusid/models/instrument_definition.py +2 -2
- lusid/models/instrument_definition_format.py +4 -4
- lusid/models/instrument_entity.py +7 -7
- lusid/models/instrument_event.py +2 -2
- lusid/models/instrument_event_configuration.py +1 -1
- lusid/models/instrument_event_holder.py +7 -21
- lusid/models/instrument_event_instruction.py +6 -6
- lusid/models/instrument_event_instruction_request.py +5 -5
- lusid/models/instrument_event_instructions_response.py +1 -1
- lusid/models/instrument_id_type_descriptor.py +3 -3
- lusid/models/instrument_id_value.py +2 -2
- lusid/models/instrument_leg.py +2 -2
- lusid/models/instrument_list.py +2 -2
- lusid/models/instrument_list_compliance_parameter.py +2 -2
- lusid/models/instrument_match.py +1 -1
- lusid/models/instrument_models.py +2 -2
- lusid/models/instrument_payment_diary.py +5 -5
- lusid/models/instrument_payment_diary_leg.py +2 -2
- lusid/models/instrument_payment_diary_row.py +4 -4
- lusid/models/instrument_properties.py +2 -2
- lusid/models/instrument_resolution_detail.py +3 -23
- lusid/models/instrument_search_property.py +3 -3
- lusid/models/interest_rate_swap.py +3 -3
- lusid/models/interest_rate_swaption.py +4 -4
- lusid/models/intermediate_compliance_step.py +3 -3
- lusid/models/intermediate_compliance_step_request.py +3 -10
- lusid/models/intermediate_securities_distribution_event.py +3 -3
- lusid/models/ir_vol_cube_data.py +3 -3
- lusid/models/ir_vol_dependency.py +4 -4
- lusid/models/is_business_day_response.py +1 -1
- lusid/models/journal_entry_line.py +18 -18
- lusid/models/journal_entry_line_share_class_breakdown.py +2 -2
- lusid/models/journal_entry_lines_query_parameters.py +3 -13
- lusid/models/label_value_set.py +1 -1
- lusid/models/lapse_election.py +2 -2
- lusid/models/leg_definition.py +7 -7
- lusid/models/legal_entity.py +5 -5
- lusid/models/level_step.py +1 -1
- lusid/models/life_cycle_event_lineage.py +6 -6
- lusid/models/life_cycle_event_value.py +2 -2
- lusid/models/lineage_member.py +5 -5
- lusid/models/link.py +5 -5
- lusid/models/list_aggregation_reconciliation.py +1 -1
- lusid/models/list_aggregation_response.py +3 -3
- lusid/models/list_complex_market_data_with_meta_data_response.py +2 -2
- lusid/models/loan_facility.py +4 -4
- lusid/models/loan_interest_repayment_event.py +3 -3
- lusid/models/loan_period.py +1 -1
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lock_period_diary_entry_request.py +2 -12
- lusid/models/lusid_instrument.py +2 -2
- lusid/models/lusid_problem_details.py +6 -6
- lusid/models/lusid_trade_ticket.py +10 -20
- lusid/models/lusid_unique_id.py +3 -3
- lusid/models/lusid_validation_problem_details.py +6 -6
- lusid/models/mapped_string.py +4 -4
- lusid/models/mapping.py +5 -26
- lusid/models/mapping_rule.py +4 -4
- lusid/models/mark_to_market_conventions.py +2 -2
- lusid/models/market_context.py +1 -1
- lusid/models/market_context_suppliers.py +6 -6
- lusid/models/market_data_key_rule.py +10 -17
- lusid/models/market_data_options.py +2 -2
- lusid/models/market_data_overrides.py +1 -1
- lusid/models/market_data_specific_rule.py +10 -17
- lusid/models/market_options.py +6 -33
- lusid/models/market_quote.py +2 -2
- lusid/models/mastered_instrument.py +8 -8
- lusid/models/match_criterion.py +2 -2
- lusid/models/maturity_event.py +2 -2
- lusid/models/mbs_coupon_event.py +3 -3
- lusid/models/mbs_interest_deferral_event.py +3 -3
- lusid/models/mbs_interest_shortfall_event.py +3 -3
- lusid/models/mbs_principal_event.py +3 -3
- lusid/models/mbs_principal_write_off_event.py +3 -3
- lusid/models/membership.py +4 -4
- lusid/models/membership_and_status.py +5 -5
- lusid/models/merger_event.py +3 -3
- lusid/models/metric_value.py +2 -2
- lusid/models/model_options.py +2 -2
- lusid/models/model_property.py +2 -2
- lusid/models/model_schema.py +3 -3
- lusid/models/model_selection.py +3 -3
- lusid/models/move_orders_to_different_blocks_request.py +1 -1
- lusid/models/moved_order_to_different_block_response.py +1 -1
- lusid/models/multi_currency_amounts.py +1 -1
- lusid/models/new_instrument.py +4 -4
- lusid/models/next_value_in_sequence_response.py +1 -1
- lusid/models/opaque_dependency.py +2 -2
- lusid/models/opaque_market_data.py +6 -6
- lusid/models/opaque_model_options.py +2 -2
- lusid/models/open_event.py +2 -2
- lusid/models/operation.py +4 -4
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +6 -6
- lusid/models/option_exercise_election.py +2 -2
- lusid/models/option_exercise_physical_event.py +6 -6
- lusid/models/optionality_schedule.py +4 -4
- lusid/models/order.py +7 -7
- lusid/models/order_by_spec.py +3 -3
- lusid/models/order_flow_configuration.py +2 -2
- lusid/models/order_graph_block.py +4 -4
- lusid/models/order_graph_block_allocation_detail.py +1 -1
- lusid/models/order_graph_block_allocation_synopsis.py +1 -1
- lusid/models/order_graph_block_execution_detail.py +1 -1
- lusid/models/order_graph_block_execution_synopsis.py +1 -1
- lusid/models/order_graph_block_order_detail.py +5 -5
- lusid/models/order_graph_block_order_synopsis.py +1 -1
- lusid/models/order_graph_block_placement_detail.py +1 -1
- lusid/models/order_graph_block_placement_synopsis.py +1 -1
- lusid/models/order_graph_block_transaction_detail.py +2 -2
- lusid/models/order_graph_block_transaction_synopsis.py +1 -1
- lusid/models/order_graph_placement.py +2 -2
- lusid/models/order_graph_placement_allocation_detail.py +1 -1
- lusid/models/order_graph_placement_allocation_synopsis.py +1 -1
- lusid/models/order_graph_placement_child_placement_detail.py +1 -1
- lusid/models/order_graph_placement_execution_detail.py +1 -1
- lusid/models/order_graph_placement_execution_synopsis.py +1 -1
- lusid/models/order_graph_placement_order_detail.py +1 -1
- lusid/models/order_graph_placement_order_synopsis.py +1 -1
- lusid/models/order_graph_placement_placement_synopsis.py +1 -1
- lusid/models/order_instruction.py +3 -3
- lusid/models/order_instruction_request.py +1 -1
- lusid/models/order_instruction_set_request.py +1 -1
- lusid/models/order_request.py +5 -5
- lusid/models/order_set_request.py +1 -1
- lusid/models/order_update_request.py +1 -1
- lusid/models/otc_confirmation.py +1 -1
- lusid/models/output_transaction.py +13 -13
- lusid/models/output_transition.py +3 -3
- lusid/models/package.py +1 -1
- lusid/models/package_request.py +1 -1
- lusid/models/package_set_request.py +1 -1
- lusid/models/paged_resource_list_of_abor.py +4 -4
- lusid/models/paged_resource_list_of_abor_configuration.py +4 -4
- lusid/models/paged_resource_list_of_account.py +4 -4
- lusid/models/paged_resource_list_of_address_key_definition.py +4 -4
- lusid/models/paged_resource_list_of_allocation.py +4 -4
- lusid/models/paged_resource_list_of_amortisation_rule_set.py +4 -4
- lusid/models/paged_resource_list_of_block.py +4 -4
- lusid/models/paged_resource_list_of_calendar.py +4 -4
- lusid/models/paged_resource_list_of_chart_of_accounts.py +4 -4
- lusid/models/paged_resource_list_of_cleardown_module_response.py +4 -4
- lusid/models/paged_resource_list_of_cleardown_module_rule.py +4 -4
- lusid/models/paged_resource_list_of_closed_period.py +4 -4
- lusid/models/paged_resource_list_of_compliance_rule_response.py +4 -4
- lusid/models/paged_resource_list_of_compliance_run_info_v2.py +4 -4
- lusid/models/paged_resource_list_of_compliance_template.py +4 -4
- lusid/models/paged_resource_list_of_corporate_action_source.py +4 -4
- lusid/models/paged_resource_list_of_custodian_account.py +4 -4
- lusid/models/paged_resource_list_of_custom_entity_definition.py +4 -4
- lusid/models/paged_resource_list_of_custom_entity_response.py +4 -4
- lusid/models/paged_resource_list_of_custom_entity_type.py +4 -4
- lusid/models/paged_resource_list_of_cut_label_definition.py +4 -4
- lusid/models/paged_resource_list_of_data_type_summary.py +4 -4
- lusid/models/paged_resource_list_of_dialect_id.py +4 -4
- lusid/models/paged_resource_list_of_diary_entry.py +4 -4
- lusid/models/paged_resource_list_of_execution.py +4 -4
- lusid/models/paged_resource_list_of_fee.py +4 -4
- lusid/models/paged_resource_list_of_fee_type.py +4 -4
- lusid/models/paged_resource_list_of_fund.py +4 -4
- lusid/models/paged_resource_list_of_fund_configuration.py +4 -4
- lusid/models/paged_resource_list_of_general_ledger_profile_response.py +4 -4
- lusid/models/paged_resource_list_of_group_reconciliation_comparison_result.py +4 -4
- lusid/models/paged_resource_list_of_group_reconciliation_comparison_ruleset.py +4 -4
- lusid/models/paged_resource_list_of_group_reconciliation_definition.py +4 -4
- lusid/models/paged_resource_list_of_identifier_definition.py +4 -4
- lusid/models/paged_resource_list_of_instrument.py +4 -4
- lusid/models/paged_resource_list_of_instrument_event_holder.py +4 -4
- lusid/models/paged_resource_list_of_instrument_event_instruction.py +4 -4
- lusid/models/paged_resource_list_of_legal_entity.py +4 -4
- lusid/models/paged_resource_list_of_order.py +4 -4
- lusid/models/paged_resource_list_of_order_graph_block.py +4 -4
- lusid/models/paged_resource_list_of_order_graph_placement.py +4 -4
- lusid/models/paged_resource_list_of_order_instruction.py +4 -4
- lusid/models/paged_resource_list_of_package.py +4 -4
- lusid/models/paged_resource_list_of_participation.py +4 -4
- lusid/models/paged_resource_list_of_person.py +4 -4
- lusid/models/paged_resource_list_of_placement.py +4 -4
- lusid/models/paged_resource_list_of_portfolio_group.py +4 -4
- lusid/models/paged_resource_list_of_portfolio_group_search_result.py +4 -4
- lusid/models/paged_resource_list_of_portfolio_search_result.py +4 -4
- lusid/models/paged_resource_list_of_posting_module_response.py +4 -4
- lusid/models/paged_resource_list_of_posting_module_rule.py +4 -4
- lusid/models/paged_resource_list_of_property_definition.py +4 -4
- lusid/models/paged_resource_list_of_property_definition_search_result.py +4 -4
- lusid/models/paged_resource_list_of_reconciliation.py +4 -4
- lusid/models/paged_resource_list_of_reference_list_response.py +4 -4
- lusid/models/paged_resource_list_of_relationship_definition.py +4 -4
- lusid/models/paged_resource_list_of_sequence_definition.py +4 -4
- lusid/models/paged_resource_list_of_staged_modification.py +4 -4
- lusid/models/paged_resource_list_of_staged_modifications_requested_change_interval.py +4 -4
- lusid/models/paged_resource_list_of_staging_rule_set.py +4 -4
- lusid/models/paged_resource_list_of_transaction_template.py +4 -4
- lusid/models/paged_resource_list_of_transaction_template_specification.py +4 -4
- lusid/models/paged_resource_list_of_translation_script_id.py +4 -4
- lusid/models/paged_resource_list_of_valuation_point_overview.py +4 -4
- lusid/models/paged_resource_list_of_virtual_row.py +4 -4
- lusid/models/paged_resource_list_of_workspace.py +4 -4
- lusid/models/paged_resource_list_of_workspace_item.py +4 -4
- lusid/models/participation.py +1 -1
- lusid/models/participation_request.py +1 -1
- lusid/models/participation_set_request.py +1 -1
- lusid/models/percent_check_step.py +3 -3
- lusid/models/percent_check_step_request.py +3 -10
- lusid/models/performance_return.py +2 -2
- lusid/models/performance_returns_metric.py +5 -5
- lusid/models/period_diary_entries_reopened_response.py +2 -2
- lusid/models/perpetual_property.py +2 -2
- lusid/models/person.py +5 -5
- lusid/models/place_blocks_request.py +1 -1
- lusid/models/placement.py +9 -9
- lusid/models/placement_request.py +8 -8
- lusid/models/placement_set_request.py +1 -1
- lusid/models/placement_update_request.py +4 -4
- lusid/models/pnl_journal_entry_line.py +2 -2
- lusid/models/portfolio.py +10 -10
- lusid/models/portfolio_cash_flow.py +3 -3
- lusid/models/portfolio_cash_ladder.py +2 -2
- lusid/models/portfolio_details.py +7 -7
- lusid/models/portfolio_entity.py +7 -7
- lusid/models/portfolio_entity_id.py +4 -18
- lusid/models/portfolio_group.py +4 -4
- lusid/models/portfolio_group_id_compliance_parameter.py +2 -2
- lusid/models/portfolio_group_id_list.py +2 -2
- lusid/models/portfolio_group_id_list_compliance_parameter.py +2 -2
- lusid/models/portfolio_group_properties.py +2 -2
- lusid/models/portfolio_group_search_result.py +4 -4
- lusid/models/portfolio_holding.py +6 -6
- lusid/models/portfolio_id.py +2 -2
- lusid/models/portfolio_id_compliance_parameter.py +2 -2
- lusid/models/portfolio_id_list.py +2 -2
- lusid/models/portfolio_id_list_compliance_parameter.py +2 -2
- lusid/models/portfolio_properties.py +2 -2
- lusid/models/portfolio_reconciliation_request.py +2 -2
- lusid/models/portfolio_result_data_key_rule.py +8 -35
- lusid/models/portfolio_return_breakdown.py +2 -2
- lusid/models/portfolio_search_result.py +6 -6
- lusid/models/portfolio_trade_ticket.py +1 -1
- lusid/models/portfolio_without_href.py +9 -9
- lusid/models/portfolios_reconciliation_request.py +1 -1
- lusid/models/posting_module_details.py +4 -21
- lusid/models/posting_module_request.py +4 -28
- lusid/models/posting_module_response.py +6 -16
- lusid/models/posting_module_rule.py +4 -25
- lusid/models/posting_module_rules_updated_response.py +2 -2
- lusid/models/pre_trade_configuration.py +2 -2
- lusid/models/premium.py +2 -2
- lusid/models/previous_fund_valuation_point_data.py +1 -1
- lusid/models/previous_nav.py +1 -1
- lusid/models/previous_share_class_breakdown.py +1 -1
- lusid/models/pricing_context.py +2 -2
- lusid/models/pricing_options.py +2 -2
- lusid/models/processed_command.py +3 -3
- lusid/models/property_definition.py +16 -16
- lusid/models/property_definition_entity.py +7 -7
- lusid/models/property_definition_search_result.py +15 -15
- lusid/models/property_filter.py +4 -4
- lusid/models/property_interval.py +2 -2
- lusid/models/property_key_compliance_parameter.py +3 -3
- lusid/models/property_key_list_compliance_parameter.py +2 -2
- lusid/models/property_list.py +2 -2
- lusid/models/property_list_compliance_parameter.py +2 -2
- lusid/models/property_schema.py +2 -2
- lusid/models/property_value.py +2 -2
- lusid/models/property_value_equals.py +4 -4
- lusid/models/property_value_in.py +3 -3
- lusid/models/protection_payout_cash_flow_event.py +3 -3
- lusid/models/quantity_instructed.py +2 -2
- lusid/models/query_applicable_instrument_events_request.py +1 -1
- lusid/models/query_bucketed_cash_flows_request.py +5 -15
- lusid/models/query_cash_flows_request.py +1 -1
- lusid/models/query_instrument_events_request.py +2 -12
- lusid/models/query_trade_tickets_request.py +1 -1
- lusid/models/queryable_key.py +9 -9
- lusid/models/quote.py +4 -4
- lusid/models/quote_access_metadata_rule.py +1 -1
- lusid/models/quote_access_metadata_rule_id.py +7 -27
- lusid/models/quote_dependency.py +4 -4
- lusid/models/quote_id.py +2 -2
- lusid/models/quote_series_id.py +7 -7
- lusid/models/raw_vendor_event.py +3 -3
- lusid/models/re_open_period_diary_entry_request.py +2 -12
- lusid/models/realised_gain_loss.py +3 -3
- lusid/models/recipe_block.py +3 -3
- lusid/models/recipe_composer.py +3 -17
- lusid/models/recipe_value.py +3 -3
- lusid/models/recombine_step.py +3 -3
- lusid/models/recommended_sort_by.py +3 -3
- lusid/models/reconcile_date_time_rule.py +3 -3
- lusid/models/reconcile_numeric_rule.py +3 -3
- lusid/models/reconcile_string_rule.py +3 -3
- lusid/models/reconciled_transaction.py +1 -1
- lusid/models/reconciliation.py +4 -4
- lusid/models/reconciliation_break.py +3 -3
- lusid/models/reconciliation_configuration.py +1 -1
- lusid/models/reconciliation_id.py +2 -2
- lusid/models/reconciliation_left_right_address_key_pair.py +3 -3
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +1 -1
- lusid/models/reconciliation_response.py +1 -1
- lusid/models/reconciliation_rule.py +2 -2
- lusid/models/reconciliation_side_configuration.py +2 -2
- lusid/models/reconciliation_transactions.py +1 -1
- lusid/models/reference_data.py +1 -1
- lusid/models/reference_instrument.py +5 -5
- lusid/models/reference_list.py +2 -2
- lusid/models/reference_list_request.py +3 -3
- lusid/models/reference_list_response.py +3 -3
- lusid/models/reference_portfolio_constituent.py +4 -4
- lusid/models/reference_portfolio_constituent_request.py +2 -2
- lusid/models/related_entity.py +5 -5
- lusid/models/relation.py +3 -3
- lusid/models/relation_definition.py +8 -8
- lusid/models/relationship.py +3 -3
- lusid/models/relationship_definition.py +8 -29
- lusid/models/relative_date_offset.py +3 -3
- lusid/models/repo.py +4 -4
- lusid/models/requested_changes.py +1 -1
- lusid/models/reset_event.py +4 -4
- lusid/models/resource_id.py +3 -3
- lusid/models/resource_list_of_access_controlled_resource.py +4 -4
- lusid/models/resource_list_of_access_metadata_value_of.py +4 -4
- lusid/models/resource_list_of_address_key_definition.py +4 -4
- lusid/models/resource_list_of_aggregated_return.py +4 -4
- lusid/models/resource_list_of_aggregation_query.py +4 -4
- lusid/models/resource_list_of_allocation.py +4 -4
- lusid/models/resource_list_of_applicable_instrument_event.py +4 -4
- lusid/models/resource_list_of_block.py +4 -4
- lusid/models/resource_list_of_block_and_orders.py +4 -4
- lusid/models/resource_list_of_calendar_date.py +4 -4
- lusid/models/resource_list_of_change.py +4 -4
- lusid/models/resource_list_of_change_history.py +4 -4
- lusid/models/resource_list_of_change_interval.py +4 -4
- lusid/models/resource_list_of_change_interval_with_order_management_detail.py +4 -4
- lusid/models/resource_list_of_compliance_breached_order_info.py +4 -4
- lusid/models/resource_list_of_compliance_rule.py +4 -4
- lusid/models/resource_list_of_compliance_rule_result.py +4 -4
- lusid/models/resource_list_of_compliance_run_info.py +4 -4
- lusid/models/resource_list_of_constituents_adjustment_header.py +4 -4
- lusid/models/resource_list_of_corporate_action.py +4 -4
- lusid/models/resource_list_of_data_model_summary.py +4 -4
- lusid/models/resource_list_of_data_type.py +4 -4
- lusid/models/resource_list_of_execution.py +4 -4
- lusid/models/resource_list_of_fee_rule.py +4 -4
- lusid/models/resource_list_of_get_cds_flow_conventions_response.py +4 -4
- lusid/models/resource_list_of_get_counterparty_agreement_response.py +4 -4
- lusid/models/resource_list_of_get_credit_support_annex_response.py +4 -4
- lusid/models/resource_list_of_get_flow_conventions_response.py +4 -4
- lusid/models/resource_list_of_get_index_convention_response.py +4 -4
- lusid/models/resource_list_of_get_recipe_composer_response.py +4 -4
- lusid/models/resource_list_of_get_recipe_response.py +4 -4
- lusid/models/resource_list_of_holdings_adjustment_header.py +4 -4
- lusid/models/resource_list_of_i_unit_definition_dto.py +4 -4
- lusid/models/resource_list_of_instrument_cash_flow.py +4 -4
- lusid/models/resource_list_of_instrument_event_holder.py +4 -4
- lusid/models/resource_list_of_instrument_id_type_descriptor.py +4 -4
- lusid/models/resource_list_of_legal_entity.py +4 -4
- lusid/models/resource_list_of_list_complex_market_data_with_meta_data_response.py +4 -4
- lusid/models/resource_list_of_mapping.py +4 -4
- lusid/models/resource_list_of_moved_order_to_different_block_response.py +4 -4
- lusid/models/resource_list_of_order.py +4 -4
- lusid/models/resource_list_of_order_instruction.py +4 -4
- lusid/models/resource_list_of_output_transaction.py +4 -4
- lusid/models/resource_list_of_package.py +4 -4
- lusid/models/resource_list_of_participation.py +4 -4
- lusid/models/resource_list_of_performance_return.py +4 -4
- lusid/models/resource_list_of_person.py +4 -4
- lusid/models/resource_list_of_placement.py +4 -4
- lusid/models/resource_list_of_portfolio.py +4 -4
- lusid/models/resource_list_of_portfolio_cash_flow.py +4 -4
- lusid/models/resource_list_of_portfolio_cash_ladder.py +4 -4
- lusid/models/resource_list_of_portfolio_trade_ticket.py +4 -4
- lusid/models/resource_list_of_processed_command.py +4 -4
- lusid/models/resource_list_of_property.py +4 -4
- lusid/models/resource_list_of_property_definition.py +4 -4
- lusid/models/resource_list_of_property_interval.py +4 -4
- lusid/models/resource_list_of_queryable_key.py +4 -4
- lusid/models/resource_list_of_quote.py +4 -4
- lusid/models/resource_list_of_quote_access_metadata_rule.py +4 -4
- lusid/models/resource_list_of_reconciliation_break.py +4 -4
- lusid/models/resource_list_of_relation.py +4 -4
- lusid/models/resource_list_of_relationship.py +4 -4
- lusid/models/resource_list_of_scope_definition.py +4 -4
- lusid/models/resource_list_of_side_definition.py +4 -4
- lusid/models/resource_list_of_string.py +4 -4
- lusid/models/resource_list_of_tax_rule_set.py +4 -4
- lusid/models/resource_list_of_transaction.py +4 -4
- lusid/models/resource_list_of_transaction_type.py +4 -4
- lusid/models/resource_list_of_value_type.py +4 -4
- lusid/models/response_meta_data.py +4 -4
- lusid/models/result_data_key_rule.py +8 -15
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +2 -2
- lusid/models/result_value.py +2 -2
- lusid/models/result_value0_d.py +3 -3
- lusid/models/result_value_bool.py +2 -2
- lusid/models/result_value_currency.py +3 -3
- lusid/models/result_value_date_time_offset.py +2 -2
- lusid/models/result_value_decimal.py +2 -2
- lusid/models/result_value_dictionary.py +2 -2
- lusid/models/result_value_int.py +2 -2
- lusid/models/result_value_string.py +3 -3
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/reverse_stock_split_event.py +3 -3
- lusid/models/rounding_configuration.py +1 -1
- lusid/models/rounding_configuration_component.py +2 -2
- lusid/models/rounding_convention.py +3 -3
- lusid/models/rules_interval.py +1 -1
- lusid/models/schedule.py +2 -2
- lusid/models/scope_definition.py +2 -2
- lusid/models/scrip_dividend_event.py +3 -3
- lusid/models/script_map_reference.py +4 -25
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +2 -2
- lusid/models/sequence_definition.py +2 -2
- lusid/models/set_amortisation_rules_request.py +1 -1
- lusid/models/set_legal_entity_identifiers_request.py +1 -1
- lusid/models/set_legal_entity_properties_request.py +1 -1
- lusid/models/set_person_identifiers_request.py +1 -1
- lusid/models/set_person_properties_request.py +1 -1
- lusid/models/set_share_class_instruments_request.py +1 -1
- lusid/models/set_transaction_configuration_alias.py +5 -12
- lusid/models/set_transaction_configuration_source_request.py +1 -1
- lusid/models/settlement_cycle.py +1 -1
- lusid/models/settlement_schedule.py +2 -2
- lusid/models/share_class_amount.py +1 -1
- lusid/models/share_class_breakdown.py +1 -1
- lusid/models/share_class_data.py +1 -1
- lusid/models/share_class_dealing_breakdown.py +1 -1
- lusid/models/share_class_details.py +5 -35
- lusid/models/share_class_pnl_breakdown.py +1 -1
- lusid/models/side_configuration_data.py +7 -7
- lusid/models/side_configuration_data_request.py +7 -7
- lusid/models/side_definition.py +9 -9
- lusid/models/side_definition_request.py +8 -8
- lusid/models/sides_definition_request.py +2 -2
- lusid/models/simple_cash_flow_loan.py +3 -3
- lusid/models/simple_instrument.py +5 -5
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/specific_holding_pricing_info.py +2 -2
- lusid/models/spin_off_event.py +3 -3
- lusid/models/staged_modification.py +10 -10
- lusid/models/staged_modification_decision.py +5 -5
- lusid/models/staged_modification_decision_request.py +3 -3
- lusid/models/staged_modification_effective_range.py +1 -1
- lusid/models/staged_modification_staging_rule.py +3 -3
- lusid/models/staged_modifications_entity_hrefs.py +4 -4
- lusid/models/staged_modifications_info.py +2 -2
- lusid/models/staged_modifications_requested_change_interval.py +3 -3
- lusid/models/staging_rule.py +4 -4
- lusid/models/staging_rule_approval_criteria.py +2 -2
- lusid/models/staging_rule_match_criteria.py +3 -3
- lusid/models/staging_rule_set.py +6 -6
- lusid/models/step_schedule.py +4 -4
- lusid/models/stock_dividend_event.py +3 -3
- lusid/models/stock_split_event.py +3 -3
- lusid/models/strategy.py +2 -2
- lusid/models/string_compliance_parameter.py +3 -3
- lusid/models/string_list.py +2 -2
- lusid/models/string_list_compliance_parameter.py +2 -2
- lusid/models/structured_result_data.py +5 -5
- lusid/models/structured_result_data_id.py +5 -22
- lusid/models/sub_holding_key_value_equals.py +4 -4
- lusid/models/swap_cash_flow_event.py +3 -3
- lusid/models/swap_principal_event.py +3 -3
- lusid/models/target_tax_lot.py +1 -1
- lusid/models/target_tax_lot_request.py +1 -1
- lusid/models/tax_rule.py +3 -17
- lusid/models/tax_rule_set.py +4 -18
- lusid/models/template_field.py +6 -6
- lusid/models/tender_event.py +3 -3
- lusid/models/term_deposit.py +3 -3
- lusid/models/term_deposit_interest_event.py +3 -3
- lusid/models/term_deposit_principal_event.py +3 -3
- lusid/models/timeline.py +4 -4
- lusid/models/total_return_swap.py +2 -2
- lusid/models/touch.py +4 -4
- lusid/models/trade_ticket.py +2 -2
- lusid/models/trading_conventions.py +1 -1
- lusid/models/transaction.py +10 -10
- lusid/models/transaction_configuration_data.py +1 -1
- lusid/models/transaction_configuration_data_request.py +1 -1
- lusid/models/transaction_configuration_movement_data.py +4 -4
- lusid/models/transaction_configuration_movement_data_request.py +4 -4
- lusid/models/transaction_configuration_type_alias.py +7 -17
- lusid/models/transaction_currency_and_amount.py +3 -3
- lusid/models/transaction_date_windows.py +3 -17
- lusid/models/transaction_diagnostics.py +2 -2
- lusid/models/transaction_field_map.py +10 -10
- lusid/models/transaction_price.py +2 -2
- lusid/models/transaction_price_and_type.py +3 -3
- lusid/models/transaction_property_map.py +3 -3
- lusid/models/transaction_property_mapping.py +3 -3
- lusid/models/transaction_property_mapping_request.py +3 -3
- lusid/models/transaction_query_parameters.py +4 -4
- lusid/models/transaction_reconciliation_request.py +1 -1
- lusid/models/transaction_reconciliation_request_v2.py +1 -1
- lusid/models/transaction_request.py +9 -9
- lusid/models/transaction_set_configuration_data.py +1 -1
- lusid/models/transaction_set_configuration_data_request.py +1 -1
- lusid/models/transaction_template.py +5 -5
- lusid/models/transaction_template_request.py +2 -2
- lusid/models/transaction_template_specification.py +2 -2
- lusid/models/transaction_type.py +1 -1
- lusid/models/transaction_type_alias.py +5 -19
- lusid/models/transaction_type_calculation.py +4 -4
- lusid/models/transaction_type_details.py +4 -4
- lusid/models/transaction_type_movement.py +6 -33
- lusid/models/transaction_type_property_mapping.py +5 -25
- lusid/models/transaction_type_request.py +1 -1
- lusid/models/transactions_reconciliations_response.py +1 -1
- lusid/models/transition_event.py +2 -2
- lusid/models/translate_entities_inlined_request.py +2 -2
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_entities_response.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +2 -9
- lusid/models/translate_instrument_definitions_response.py +2 -2
- lusid/models/translate_trade_ticket_request.py +2 -9
- lusid/models/translate_trade_tickets_response.py +2 -2
- lusid/models/translation_context.py +1 -1
- lusid/models/translation_input.py +2 -2
- lusid/models/translation_result.py +2 -2
- lusid/models/translation_script.py +2 -2
- lusid/models/translation_script_id.py +4 -25
- lusid/models/trial_balance.py +5 -5
- lusid/models/trial_balance_query_parameters.py +3 -13
- lusid/models/trigger_event.py +4 -4
- lusid/models/typed_resource_id.py +4 -25
- lusid/models/unitisation_data.py +1 -1
- lusid/models/units_ratio.py +1 -1
- lusid/models/update_amortisation_rule_set_details_request.py +3 -20
- lusid/models/update_calendar_request.py +2 -9
- lusid/models/update_compliance_template_request.py +3 -17
- lusid/models/update_custom_data_model_request.py +4 -28
- lusid/models/update_custom_entity_definition_request.py +3 -17
- lusid/models/update_custom_entity_type_request.py +3 -17
- lusid/models/update_cut_label_definition_request.py +4 -21
- lusid/models/update_data_type_request.py +3 -23
- lusid/models/update_deposit_amount_event.py +2 -2
- lusid/models/update_derived_property_definition_request.py +4 -4
- lusid/models/update_fee_type_request.py +3 -13
- lusid/models/update_group_reconciliation_comparison_ruleset_request.py +3 -3
- lusid/models/update_group_reconciliation_definition_request.py +3 -3
- lusid/models/update_identifier_definition_request.py +4 -34
- lusid/models/update_instrument_identifier_request.py +4 -4
- lusid/models/update_orders_response.py +2 -2
- lusid/models/update_placements_response.py +2 -2
- lusid/models/update_portfolio_group_request.py +3 -3
- lusid/models/update_portfolio_request.py +3 -3
- lusid/models/update_property_definition_request.py +3 -3
- lusid/models/update_reconciliation_request.py +3 -3
- lusid/models/update_reference_data_request.py +1 -1
- lusid/models/update_relationship_definition_request.py +4 -25
- lusid/models/update_staging_rule_set_request.py +3 -3
- lusid/models/update_tax_rule_set_request.py +3 -17
- lusid/models/update_timeline_request.py +3 -3
- lusid/models/update_unit_request.py +4 -34
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_complex_market_data_request.py +1 -1
- lusid/models/upsert_compliance_rule_request.py +4 -4
- lusid/models/upsert_compliance_run_summary_request.py +2 -2
- lusid/models/upsert_compliance_run_summary_result.py +2 -2
- lusid/models/upsert_corporate_action_request.py +3 -20
- lusid/models/upsert_corporate_actions_response.py +2 -2
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_credit_support_annex_request.py +1 -1
- lusid/models/upsert_custom_entities_response.py +2 -2
- lusid/models/upsert_custom_entity_access_metadata_request.py +1 -1
- lusid/models/upsert_dialect_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_instrument_event_request.py +4 -21
- lusid/models/upsert_instrument_events_response.py +2 -2
- lusid/models/upsert_instrument_properties_response.py +1 -1
- lusid/models/upsert_instrument_property_request.py +3 -3
- lusid/models/upsert_instruments_response.py +2 -2
- lusid/models/upsert_legal_entities_response.py +2 -2
- lusid/models/upsert_legal_entity_access_metadata_request.py +1 -1
- lusid/models/upsert_legal_entity_request.py +3 -20
- lusid/models/upsert_person_access_metadata_request.py +1 -1
- lusid/models/upsert_person_request.py +3 -3
- lusid/models/upsert_persons_response.py +1 -1
- lusid/models/upsert_portfolio_access_metadata_request.py +1 -1
- lusid/models/upsert_portfolio_group_access_metadata_request.py +1 -1
- lusid/models/upsert_portfolio_transactions_response.py +2 -2
- lusid/models/upsert_quote_access_metadata_rule_request.py +1 -1
- lusid/models/upsert_quote_request.py +2 -2
- lusid/models/upsert_quotes_response.py +2 -2
- lusid/models/upsert_recipe_composer_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/upsert_reference_portfolio_constituent_properties_request.py +1 -1
- lusid/models/upsert_reference_portfolio_constituent_properties_response.py +2 -2
- lusid/models/upsert_reference_portfolio_constituents_request.py +4 -4
- lusid/models/upsert_reference_portfolio_constituents_response.py +2 -2
- lusid/models/upsert_result_values_data_request.py +2 -2
- lusid/models/upsert_returns_response.py +2 -2
- lusid/models/upsert_single_structured_data_response.py +2 -2
- lusid/models/upsert_structured_data_response.py +2 -2
- lusid/models/upsert_structured_result_data_request.py +1 -1
- lusid/models/upsert_transaction_properties_response.py +2 -2
- lusid/models/upsert_translation_script_request.py +2 -2
- lusid/models/upsert_valuation_point_request.py +3 -20
- lusid/models/user.py +2 -2
- lusid/models/valuation_point_data_query_parameters.py +1 -1
- lusid/models/valuation_point_data_request.py +2 -9
- lusid/models/valuation_point_data_response.py +6 -6
- lusid/models/valuation_point_overview.py +5 -5
- lusid/models/valuation_point_resource_list_of_accounted_transaction.py +4 -4
- lusid/models/valuation_point_resource_list_of_fund_journal_entry_line.py +4 -4
- lusid/models/valuation_point_resource_list_of_pnl_journal_entry_line.py +4 -4
- lusid/models/valuation_point_resource_list_of_trial_balance.py +4 -4
- lusid/models/valuation_request.py +2 -2
- lusid/models/valuation_schedule.py +6 -6
- lusid/models/valuations_reconciliation_request.py +1 -1
- lusid/models/vendor_dependency.py +3 -3
- lusid/models/vendor_model_rule.py +6 -6
- lusid/models/version.py +7 -7
- lusid/models/version_summary_dto.py +4 -4
- lusid/models/versioned_resource_list_of_a2_b_data_record.py +4 -4
- lusid/models/versioned_resource_list_of_a2_b_movement_record.py +4 -4
- lusid/models/versioned_resource_list_of_holding_contributor.py +4 -4
- lusid/models/versioned_resource_list_of_journal_entry_line.py +4 -4
- lusid/models/versioned_resource_list_of_output_transaction.py +4 -4
- lusid/models/versioned_resource_list_of_portfolio_holding.py +4 -4
- lusid/models/versioned_resource_list_of_transaction.py +4 -4
- lusid/models/versioned_resource_list_of_trial_balance.py +4 -4
- lusid/models/versioned_resource_list_with_warnings_of_portfolio_holding.py +4 -4
- lusid/models/virtual_document.py +1 -1
- lusid/models/virtual_document_row.py +1 -1
- lusid/models/virtual_row.py +1 -1
- lusid/models/warning.py +3 -3
- lusid/models/weekend_mask.py +2 -9
- lusid/models/weighted_instrument.py +3 -3
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +12 -12
- lusid/models/weighted_instruments.py +1 -1
- lusid/models/workspace.py +3 -3
- lusid/models/workspace_creation_request.py +3 -10
- lusid/models/workspace_item.py +5 -12
- lusid/models/workspace_item_creation_request.py +5 -26
- lusid/models/workspace_item_update_request.py +3 -10
- lusid/models/workspace_update_request.py +2 -2
- lusid/models/yield_curve_data.py +3 -3
- {lusid_sdk-2.1.721.dist-info → lusid_sdk-2.1.723.dist-info}/METADATA +1 -1
- lusid_sdk-2.1.723.dist-info/RECORD +1288 -0
- lusid_sdk-2.1.721.dist-info/RECORD +0 -1288
- {lusid_sdk-2.1.721.dist-info → lusid_sdk-2.1.723.dist-info}/WHEEL +0 -0
lusid/api/portfolios_api.py
CHANGED
@@ -67,6 +67,10 @@ from lusid.exceptions import ( # noqa: F401
|
|
67
67
|
)
|
68
68
|
from lusid.extensions.configuration_options import ConfigurationOptions
|
69
69
|
|
70
|
+
# ensure templated type usages are imported
|
71
|
+
from pydantic.v1 import Field, StrictStr
|
72
|
+
from typing import Optional
|
73
|
+
from typing_extensions import Annotated
|
70
74
|
|
71
75
|
class PortfoliosApi:
|
72
76
|
"""NOTE: This class is auto generated by OpenAPI Generator
|
@@ -80,16 +84,17 @@ class PortfoliosApi:
|
|
80
84
|
api_client = ApiClient.get_default()
|
81
85
|
self.api_client = api_client
|
82
86
|
|
87
|
+
|
83
88
|
@overload
|
84
|
-
async 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, **kwargs) -> BatchUpsertPortfolioAccessMetadataResponse: # noqa: E501
|
89
|
+
async 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, **kwargs) -> BatchUpsertPortfolioAccessMetadataResponse: # noqa: E501
|
85
90
|
...
|
86
91
|
|
87
92
|
@overload
|
88
|
-
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]=True, **kwargs) -> BatchUpsertPortfolioAccessMetadataResponse: # noqa: E501
|
93
|
+
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]=True, **kwargs) -> BatchUpsertPortfolioAccessMetadataResponse: # noqa: E501
|
89
94
|
...
|
90
95
|
|
91
96
|
@validate_arguments
|
92
|
-
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
|
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
|
93
98
|
"""[EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios # noqa: E501
|
94
99
|
|
95
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
|
@@ -124,7 +129,7 @@ class PortfoliosApi:
|
|
124
129
|
return self.batch_upsert_portfolio_access_metadata_with_http_info(request_body, effective_at, effective_until, **kwargs) # noqa: E501
|
125
130
|
|
126
131
|
@validate_arguments
|
127
|
-
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
|
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
|
128
133
|
"""[EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios # noqa: E501
|
129
134
|
|
130
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
|
@@ -254,16 +259,17 @@ class PortfoliosApi:
|
|
254
259
|
collection_formats=_collection_formats,
|
255
260
|
_request_auth=_params.get('_request_auth'))
|
256
261
|
|
262
|
+
|
257
263
|
@overload
|
258
|
-
async def delete_instrument_event_instruction(self, scope : Annotated[
|
264
|
+
async def delete_instrument_event_instruction(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.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be deleted.")], 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, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
259
265
|
...
|
260
266
|
|
261
267
|
@overload
|
262
|
-
def delete_instrument_event_instruction(self, scope : Annotated[
|
268
|
+
def delete_instrument_event_instruction(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.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be deleted.")], 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, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
263
269
|
...
|
264
270
|
|
265
271
|
@validate_arguments
|
266
|
-
def delete_instrument_event_instruction(self, scope : Annotated[
|
272
|
+
def delete_instrument_event_instruction(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.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be deleted.")], 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, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
267
273
|
"""[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction # noqa: E501
|
268
274
|
|
269
275
|
Delete a particular instruction for a particular portfolio # noqa: E501
|
@@ -300,7 +306,7 @@ class PortfoliosApi:
|
|
300
306
|
return self.delete_instrument_event_instruction_with_http_info(scope, code, instrument_event_instruction_id, portfolio_effective_at, **kwargs) # noqa: E501
|
301
307
|
|
302
308
|
@validate_arguments
|
303
|
-
def delete_instrument_event_instruction_with_http_info(self, scope : Annotated[
|
309
|
+
def delete_instrument_event_instruction_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.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be deleted.")], 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, **kwargs) -> ApiResponse: # noqa: E501
|
304
310
|
"""[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction # noqa: E501
|
305
311
|
|
306
312
|
Delete a particular instruction for a particular portfolio # noqa: E501
|
@@ -429,16 +435,17 @@ class PortfoliosApi:
|
|
429
435
|
collection_formats=_collection_formats,
|
430
436
|
_request_auth=_params.get('_request_auth'))
|
431
437
|
|
438
|
+
|
432
439
|
@overload
|
433
|
-
async def delete_key_from_portfolio_access_metadata(self, scope : Annotated[
|
440
|
+
async def delete_key_from_portfolio_access_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Quote Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], metadata_key : Annotated[StrictStr, Field(..., description="The metadataKey identifying the access metadata entry to delete")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date to delete at, if this is not supplied, it will delete all data found")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
434
441
|
...
|
435
442
|
|
436
443
|
@overload
|
437
|
-
def delete_key_from_portfolio_access_metadata(self, scope : Annotated[
|
444
|
+
def delete_key_from_portfolio_access_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Quote Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], metadata_key : Annotated[StrictStr, Field(..., description="The metadataKey identifying the access metadata entry to delete")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date to delete at, if this is not supplied, it will delete all data found")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the delete 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]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
438
445
|
...
|
439
446
|
|
440
447
|
@validate_arguments
|
441
|
-
def delete_key_from_portfolio_access_metadata(self, scope : Annotated[
|
448
|
+
def delete_key_from_portfolio_access_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Quote Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], metadata_key : Annotated[StrictStr, Field(..., description="The metadataKey identifying the access metadata entry to delete")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date to delete at, if this is not supplied, it will delete all data found")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the delete 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[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
442
449
|
"""DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule # noqa: E501
|
443
450
|
|
444
451
|
Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts # noqa: E501
|
@@ -477,7 +484,7 @@ class PortfoliosApi:
|
|
477
484
|
return self.delete_key_from_portfolio_access_metadata_with_http_info(scope, code, metadata_key, effective_at, effective_until, **kwargs) # noqa: E501
|
478
485
|
|
479
486
|
@validate_arguments
|
480
|
-
def delete_key_from_portfolio_access_metadata_with_http_info(self, scope : Annotated[
|
487
|
+
def delete_key_from_portfolio_access_metadata_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Quote Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], metadata_key : Annotated[StrictStr, Field(..., description="The metadataKey identifying the access metadata entry to delete")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date to delete at, if this is not supplied, it will delete all data found")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the delete 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
|
481
488
|
"""DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule # noqa: E501
|
482
489
|
|
483
490
|
Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts # noqa: E501
|
@@ -615,16 +622,17 @@ class PortfoliosApi:
|
|
615
622
|
collection_formats=_collection_formats,
|
616
623
|
_request_auth=_params.get('_request_auth'))
|
617
624
|
|
625
|
+
|
618
626
|
@overload
|
619
|
-
async def delete_portfolio(self, scope : Annotated[
|
627
|
+
async 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.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
620
628
|
...
|
621
629
|
|
622
630
|
@overload
|
623
|
-
def delete_portfolio(self, scope : Annotated[
|
631
|
+
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]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
624
632
|
...
|
625
633
|
|
626
634
|
@validate_arguments
|
627
|
-
def delete_portfolio(self, scope : Annotated[
|
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
|
628
636
|
"""DeletePortfolio: Delete portfolio # noqa: E501
|
629
637
|
|
630
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
|
@@ -657,7 +665,7 @@ class PortfoliosApi:
|
|
657
665
|
return self.delete_portfolio_with_http_info(scope, code, **kwargs) # noqa: E501
|
658
666
|
|
659
667
|
@validate_arguments
|
660
|
-
def delete_portfolio_with_http_info(self, scope : Annotated[
|
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
|
661
669
|
"""DeletePortfolio: Delete portfolio # noqa: E501
|
662
670
|
|
663
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
|
@@ -774,16 +782,17 @@ class PortfoliosApi:
|
|
774
782
|
collection_formats=_collection_formats,
|
775
783
|
_request_auth=_params.get('_request_auth'))
|
776
784
|
|
785
|
+
|
777
786
|
@overload
|
778
|
-
async def delete_portfolio_properties(self, scope : Annotated[
|
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
|
779
788
|
...
|
780
789
|
|
781
790
|
@overload
|
782
|
-
def delete_portfolio_properties(self, scope : Annotated[
|
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
|
783
792
|
...
|
784
793
|
|
785
794
|
@validate_arguments
|
786
|
-
def delete_portfolio_properties(self, scope : Annotated[
|
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
|
787
796
|
"""DeletePortfolioProperties: Delete portfolio properties # noqa: E501
|
788
797
|
|
789
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
|
@@ -820,7 +829,7 @@ class PortfoliosApi:
|
|
820
829
|
return self.delete_portfolio_properties_with_http_info(scope, code, property_keys, effective_at, **kwargs) # noqa: E501
|
821
830
|
|
822
831
|
@validate_arguments
|
823
|
-
def delete_portfolio_properties_with_http_info(self, scope : Annotated[
|
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
|
824
833
|
"""DeletePortfolioProperties: Delete portfolio properties # noqa: E501
|
825
834
|
|
826
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
|
@@ -950,16 +959,17 @@ class PortfoliosApi:
|
|
950
959
|
collection_formats=_collection_formats,
|
951
960
|
_request_auth=_params.get('_request_auth'))
|
952
961
|
|
962
|
+
|
953
963
|
@overload
|
954
|
-
async def delete_portfolio_returns(self, scope : Annotated[
|
964
|
+
async def delete_portfolio_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.")], from_effective_at : Annotated[StrictStr, Field(..., description="The start date from which to delete the Returns.")], to_effective_at : Annotated[StrictStr, Field(..., description="The end date from which to delete the Returns.")], period : Annotated[Optional[StrictStr], Field( description="The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
955
965
|
...
|
956
966
|
|
957
967
|
@overload
|
958
|
-
def delete_portfolio_returns(self, scope : Annotated[
|
968
|
+
def delete_portfolio_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.")], from_effective_at : Annotated[StrictStr, Field(..., description="The start date from which to delete the Returns.")], to_effective_at : Annotated[StrictStr, Field(..., description="The end date from which to delete the Returns.")], period : Annotated[Optional[StrictStr], Field( description="The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
959
969
|
...
|
960
970
|
|
961
971
|
@validate_arguments
|
962
|
-
def delete_portfolio_returns(self, scope : Annotated[
|
972
|
+
def delete_portfolio_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.")], from_effective_at : Annotated[StrictStr, Field(..., description="The start date from which to delete the Returns.")], to_effective_at : Annotated[StrictStr, Field(..., description="The end date from which to delete the Returns.")], period : Annotated[Optional[StrictStr], Field( description="The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
963
973
|
"""[EARLY ACCESS] DeletePortfolioReturns: Delete Returns # noqa: E501
|
964
974
|
|
965
975
|
Cancel one or more Returns which exist into the specified portfolio. # noqa: E501
|
@@ -1002,7 +1012,7 @@ class PortfoliosApi:
|
|
1002
1012
|
return self.delete_portfolio_returns_with_http_info(scope, code, return_scope, return_code, from_effective_at, to_effective_at, period, **kwargs) # noqa: E501
|
1003
1013
|
|
1004
1014
|
@validate_arguments
|
1005
|
-
def delete_portfolio_returns_with_http_info(self, scope : Annotated[
|
1015
|
+
def delete_portfolio_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.")], from_effective_at : Annotated[StrictStr, Field(..., description="The start date from which to delete the Returns.")], to_effective_at : Annotated[StrictStr, Field(..., description="The end date from which to delete the Returns.")], period : Annotated[Optional[StrictStr], Field( description="The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1006
1016
|
"""[EARLY ACCESS] DeletePortfolioReturns: Delete Returns # noqa: E501
|
1007
1017
|
|
1008
1018
|
Cancel one or more Returns which exist into the specified portfolio. # noqa: E501
|
@@ -1149,16 +1159,17 @@ class PortfoliosApi:
|
|
1149
1159
|
collection_formats=_collection_formats,
|
1150
1160
|
_request_auth=_params.get('_request_auth'))
|
1151
1161
|
|
1162
|
+
|
1152
1163
|
@overload
|
1153
|
-
async def get_aggregated_returns_dispersion_metrics(self, scope : Annotated[
|
1164
|
+
async 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, **kwargs) -> CompositeDispersionResponse: # noqa: E501
|
1154
1165
|
...
|
1155
1166
|
|
1156
1167
|
@overload
|
1157
|
-
def get_aggregated_returns_dispersion_metrics(self, scope : Annotated[
|
1168
|
+
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]=True, **kwargs) -> CompositeDispersionResponse: # noqa: E501
|
1158
1169
|
...
|
1159
1170
|
|
1160
1171
|
@validate_arguments
|
1161
|
-
def get_aggregated_returns_dispersion_metrics(self, scope : Annotated[
|
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
|
1162
1173
|
"""[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric # noqa: E501
|
1163
1174
|
|
1164
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
|
@@ -1195,7 +1206,7 @@ class PortfoliosApi:
|
|
1195
1206
|
return self.get_aggregated_returns_dispersion_metrics_with_http_info(scope, code, aggregated_returns_dispersion_request, as_at, **kwargs) # noqa: E501
|
1196
1207
|
|
1197
1208
|
@validate_arguments
|
1198
|
-
def get_aggregated_returns_dispersion_metrics_with_http_info(self, scope : Annotated[
|
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
|
1199
1210
|
"""[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric # noqa: E501
|
1200
1211
|
|
1201
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
|
@@ -1334,16 +1345,17 @@ class PortfoliosApi:
|
|
1334
1345
|
collection_formats=_collection_formats,
|
1335
1346
|
_request_auth=_params.get('_request_auth'))
|
1336
1347
|
|
1348
|
+
|
1337
1349
|
@overload
|
1338
|
-
async def get_composite_breakdown(self, scope : Annotated[
|
1350
|
+
async def get_composite_breakdown(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], composite_breakdown_request : Annotated[CompositeBreakdownRequest, Field(..., description="The request used in the GetCompositeBreakdown.")], 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, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, **kwargs) -> CompositeBreakdownResponse: # noqa: E501
|
1339
1351
|
...
|
1340
1352
|
|
1341
1353
|
@overload
|
1342
|
-
def get_composite_breakdown(self, scope : Annotated[
|
1354
|
+
def get_composite_breakdown(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], composite_breakdown_request : Annotated[CompositeBreakdownRequest, Field(..., description="The request used in the GetCompositeBreakdown.")], 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, 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]=True, **kwargs) -> CompositeBreakdownResponse: # noqa: E501
|
1343
1355
|
...
|
1344
1356
|
|
1345
1357
|
@validate_arguments
|
1346
|
-
def get_composite_breakdown(self, scope : Annotated[
|
1358
|
+
def get_composite_breakdown(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], composite_breakdown_request : Annotated[CompositeBreakdownRequest, Field(..., description="The request used in the GetCompositeBreakdown.")], 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, 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[CompositeBreakdownResponse, Awaitable[CompositeBreakdownResponse]]: # noqa: E501
|
1347
1359
|
"""[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated # noqa: E501
|
1348
1360
|
|
1349
1361
|
Calculate the Composite Returns and return this with the constituents which are included in this calculation # noqa: E501
|
@@ -1384,7 +1396,7 @@ class PortfoliosApi:
|
|
1384
1396
|
return self.get_composite_breakdown_with_http_info(scope, code, composite_breakdown_request, from_effective_at, to_effective_at, as_at, **kwargs) # noqa: E501
|
1385
1397
|
|
1386
1398
|
@validate_arguments
|
1387
|
-
def get_composite_breakdown_with_http_info(self, scope : Annotated[
|
1399
|
+
def get_composite_breakdown_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], composite_breakdown_request : Annotated[CompositeBreakdownRequest, Field(..., description="The request used in the GetCompositeBreakdown.")], 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, 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
|
1388
1400
|
"""[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated # noqa: E501
|
1389
1401
|
|
1390
1402
|
Calculate the Composite Returns and return this with the constituents which are included in this calculation # noqa: E501
|
@@ -1535,16 +1547,17 @@ class PortfoliosApi:
|
|
1535
1547
|
collection_formats=_collection_formats,
|
1536
1548
|
_request_auth=_params.get('_request_auth'))
|
1537
1549
|
|
1550
|
+
|
1538
1551
|
@overload
|
1539
|
-
async def get_instrument_event_instruction(self, scope : Annotated[
|
1552
|
+
async def get_instrument_event_instruction(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.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be retrieved.")], 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 instruction. Defaults to return the latest version of the instruction if not specified.")] = None, **kwargs) -> InstrumentEventInstruction: # noqa: E501
|
1540
1553
|
...
|
1541
1554
|
|
1542
1555
|
@overload
|
1543
|
-
def get_instrument_event_instruction(self, scope : Annotated[
|
1556
|
+
def get_instrument_event_instruction(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.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be retrieved.")], 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 instruction. Defaults to return the latest version of the instruction if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentEventInstruction: # noqa: E501
|
1544
1557
|
...
|
1545
1558
|
|
1546
1559
|
@validate_arguments
|
1547
|
-
def get_instrument_event_instruction(self, scope : Annotated[
|
1560
|
+
def get_instrument_event_instruction(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.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be retrieved.")], 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 instruction. Defaults to return the latest version of the instruction if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentEventInstruction, Awaitable[InstrumentEventInstruction]]: # noqa: E501
|
1548
1561
|
"""[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction # noqa: E501
|
1549
1562
|
|
1550
1563
|
Get a particular instruction for a particular portfolio # noqa: E501
|
@@ -1583,7 +1596,7 @@ class PortfoliosApi:
|
|
1583
1596
|
return self.get_instrument_event_instruction_with_http_info(scope, code, instrument_event_instruction_id, portfolio_effective_at, as_at, **kwargs) # noqa: E501
|
1584
1597
|
|
1585
1598
|
@validate_arguments
|
1586
|
-
def get_instrument_event_instruction_with_http_info(self, scope : Annotated[
|
1599
|
+
def get_instrument_event_instruction_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.")], instrument_event_instruction_id : Annotated[StrictStr, Field(..., description="The id of the instruction to be retrieved.")], 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 instruction. Defaults to return the latest version of the instruction if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1587
1600
|
"""[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction # noqa: E501
|
1588
1601
|
|
1589
1602
|
Get a particular instruction for a particular portfolio # noqa: E501
|
@@ -1721,16 +1734,17 @@ class PortfoliosApi:
|
|
1721
1734
|
collection_formats=_collection_formats,
|
1722
1735
|
_request_auth=_params.get('_request_auth'))
|
1723
1736
|
|
1737
|
+
|
1724
1738
|
@overload
|
1725
|
-
async def get_portfolio(self, scope : Annotated[
|
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
|
1726
1740
|
...
|
1727
1741
|
|
1728
1742
|
@overload
|
1729
|
-
def get_portfolio(self, scope : Annotated[
|
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
|
1730
1744
|
...
|
1731
1745
|
|
1732
1746
|
@validate_arguments
|
1733
|
-
def get_portfolio(self, scope : Annotated[
|
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
|
1734
1748
|
"""GetPortfolio: Get portfolio # noqa: E501
|
1735
1749
|
|
1736
1750
|
Retrieve the definition of a particular portfolio. # noqa: E501
|
@@ -1771,7 +1785,7 @@ class PortfoliosApi:
|
|
1771
1785
|
return self.get_portfolio_with_http_info(scope, code, effective_at, as_at, property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
1772
1786
|
|
1773
1787
|
@validate_arguments
|
1774
|
-
def get_portfolio_with_http_info(self, scope : Annotated[
|
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
|
1775
1789
|
"""GetPortfolio: Get portfolio # noqa: E501
|
1776
1790
|
|
1777
1791
|
Retrieve the definition of a particular portfolio. # noqa: E501
|
@@ -1917,16 +1931,17 @@ class PortfoliosApi:
|
|
1917
1931
|
collection_formats=_collection_formats,
|
1918
1932
|
_request_auth=_params.get('_request_auth'))
|
1919
1933
|
|
1934
|
+
|
1920
1935
|
@overload
|
1921
|
-
async def get_portfolio_aggregate_returns(self, scope : Annotated[
|
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
|
1922
1937
|
...
|
1923
1938
|
|
1924
1939
|
@overload
|
1925
|
-
def get_portfolio_aggregate_returns(self, scope : Annotated[
|
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
|
1926
1941
|
...
|
1927
1942
|
|
1928
1943
|
@validate_arguments
|
1929
|
-
def get_portfolio_aggregate_returns(self, scope : Annotated[
|
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
|
1930
1945
|
"""[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). # noqa: E501
|
1931
1946
|
|
1932
1947
|
Aggregate Returns which are on the specified portfolio. # noqa: E501
|
@@ -1983,7 +1998,7 @@ class PortfoliosApi:
|
|
1983
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
|
1984
1999
|
|
1985
2000
|
@validate_arguments
|
1986
|
-
def get_portfolio_aggregate_returns_with_http_info(self, scope : Annotated[
|
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
|
1987
2002
|
"""[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). # noqa: E501
|
1988
2003
|
|
1989
2004
|
Aggregate Returns which are on the specified portfolio. # noqa: E501
|
@@ -2176,16 +2191,17 @@ class PortfoliosApi:
|
|
2176
2191
|
collection_formats=_collection_formats,
|
2177
2192
|
_request_auth=_params.get('_request_auth'))
|
2178
2193
|
|
2194
|
+
|
2179
2195
|
@overload
|
2180
|
-
async def get_portfolio_aggregated_returns(self, scope : Annotated[
|
2196
|
+
async def get_portfolio_aggregated_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], aggregated_returns_request : Annotated[AggregatedReturnsRequest, Field(..., description="The request used in the AggregatedReturns.")], 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, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, **kwargs) -> AggregatedReturnsResponse: # noqa: E501
|
2181
2197
|
...
|
2182
2198
|
|
2183
2199
|
@overload
|
2184
|
-
def get_portfolio_aggregated_returns(self, scope : Annotated[
|
2200
|
+
def get_portfolio_aggregated_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], aggregated_returns_request : Annotated[AggregatedReturnsRequest, Field(..., description="The request used in the AggregatedReturns.")], 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, 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]=True, **kwargs) -> AggregatedReturnsResponse: # noqa: E501
|
2185
2201
|
...
|
2186
2202
|
|
2187
2203
|
@validate_arguments
|
2188
|
-
def get_portfolio_aggregated_returns(self, scope : Annotated[
|
2204
|
+
def get_portfolio_aggregated_returns(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the Portfolio.")], aggregated_returns_request : Annotated[AggregatedReturnsRequest, Field(..., description="The request used in the AggregatedReturns.")], 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, 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[AggregatedReturnsResponse, Awaitable[AggregatedReturnsResponse]]: # noqa: E501
|
2189
2205
|
"""GetPortfolioAggregatedReturns: Aggregated Returns # noqa: E501
|
2190
2206
|
|
2191
2207
|
Aggregate Returns which are on the specified portfolio. # noqa: E501
|
@@ -2226,7 +2242,7 @@ class PortfoliosApi:
|
|
2226
2242
|
return self.get_portfolio_aggregated_returns_with_http_info(scope, code, aggregated_returns_request, from_effective_at, to_effective_at, as_at, **kwargs) # noqa: E501
|
2227
2243
|
|
2228
2244
|
@validate_arguments
|
2229
|
-
def get_portfolio_aggregated_returns_with_http_info(self, scope : Annotated[
|
2245
|
+
def get_portfolio_aggregated_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.")], aggregated_returns_request : Annotated[AggregatedReturnsRequest, Field(..., description="The request used in the AggregatedReturns.")], 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, 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
|
2230
2246
|
"""GetPortfolioAggregatedReturns: Aggregated Returns # noqa: E501
|
2231
2247
|
|
2232
2248
|
Aggregate Returns which are on the specified portfolio. # noqa: E501
|
@@ -2377,16 +2393,17 @@ class PortfoliosApi:
|
|
2377
2393
|
collection_formats=_collection_formats,
|
2378
2394
|
_request_auth=_params.get('_request_auth'))
|
2379
2395
|
|
2396
|
+
|
2380
2397
|
@overload
|
2381
|
-
async def get_portfolio_commands(self, scope : Annotated[
|
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, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 500 if not specified.")] = None, **kwargs) -> ResourceListOfProcessedCommand: # noqa: E501
|
2382
2399
|
...
|
2383
2400
|
|
2384
2401
|
@overload
|
2385
|
-
def get_portfolio_commands(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
2386
2403
|
...
|
2387
2404
|
|
2388
2405
|
@validate_arguments
|
2389
|
-
def get_portfolio_commands(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
2390
2407
|
"""GetPortfolioCommands: Get portfolio commands # noqa: E501
|
2391
2408
|
|
2392
2409
|
Get all the commands that modified a particular portfolio, including any input transactions. # noqa: E501
|
@@ -2429,7 +2446,7 @@ class PortfoliosApi:
|
|
2429
2446
|
return self.get_portfolio_commands_with_http_info(scope, code, from_as_at, to_as_at, filter, page, limit, **kwargs) # noqa: E501
|
2430
2447
|
|
2431
2448
|
@validate_arguments
|
2432
|
-
def get_portfolio_commands_with_http_info(self, scope : Annotated[
|
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, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 500 if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2433
2450
|
"""GetPortfolioCommands: Get portfolio commands # noqa: E501
|
2434
2451
|
|
2435
2452
|
Get all the commands that modified a particular portfolio, including any input transactions. # noqa: E501
|
@@ -2582,16 +2599,17 @@ class PortfoliosApi:
|
|
2582
2599
|
collection_formats=_collection_formats,
|
2583
2600
|
_request_auth=_params.get('_request_auth'))
|
2584
2601
|
|
2602
|
+
|
2585
2603
|
@overload
|
2586
|
-
async def get_portfolio_metadata(self, scope : Annotated[
|
2604
|
+
async def get_portfolio_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the access metadata rule.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio access metadata.")] = None, **kwargs) -> Dict[str, List[AccessMetadataValue]]: # noqa: E501
|
2587
2605
|
...
|
2588
2606
|
|
2589
2607
|
@overload
|
2590
|
-
def get_portfolio_metadata(self, scope : Annotated[
|
2608
|
+
def get_portfolio_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the access metadata 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]=True, **kwargs) -> Dict[str, List[AccessMetadataValue]]: # noqa: E501
|
2591
2609
|
...
|
2592
2610
|
|
2593
2611
|
@validate_arguments
|
2594
|
-
def get_portfolio_metadata(self, scope : Annotated[
|
2612
|
+
def get_portfolio_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the access metadata 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[Dict[str, List[AccessMetadataValue]], Awaitable[Dict[str, List[AccessMetadataValue]]]]: # noqa: E501
|
2595
2613
|
"""GetPortfolioMetadata: Get access metadata rules for a portfolio # noqa: E501
|
2596
2614
|
|
2597
2615
|
Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio # noqa: E501
|
@@ -2628,7 +2646,7 @@ class PortfoliosApi:
|
|
2628
2646
|
return self.get_portfolio_metadata_with_http_info(scope, code, effective_at, as_at, **kwargs) # noqa: E501
|
2629
2647
|
|
2630
2648
|
@validate_arguments
|
2631
|
-
def get_portfolio_metadata_with_http_info(self, scope : Annotated[
|
2649
|
+
def get_portfolio_metadata_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Access Metadata Rule to retrieve.")], code : Annotated[StrictStr, Field(..., description="Portfolio code")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the access metadata 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
|
2632
2650
|
"""GetPortfolioMetadata: Get access metadata rules for a portfolio # noqa: E501
|
2633
2651
|
|
2634
2652
|
Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio # noqa: E501
|
@@ -2760,16 +2778,17 @@ class PortfoliosApi:
|
|
2760
2778
|
collection_formats=_collection_formats,
|
2761
2779
|
_request_auth=_params.get('_request_auth'))
|
2762
2780
|
|
2781
|
+
|
2763
2782
|
@overload
|
2764
|
-
async def get_portfolio_properties(self, scope : Annotated[
|
2783
|
+
async def get_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.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio's properties. 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 portfolio's properties. Defaults to returning the latest version of each property if not specified.")] = None, **kwargs) -> PortfolioProperties: # noqa: E501
|
2765
2784
|
...
|
2766
2785
|
|
2767
2786
|
@overload
|
2768
|
-
def get_portfolio_properties(self, scope : Annotated[
|
2787
|
+
def get_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.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio's properties. 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 portfolio's properties. Defaults to returning the latest version of each property if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> PortfolioProperties: # noqa: E501
|
2769
2788
|
...
|
2770
2789
|
|
2771
2790
|
@validate_arguments
|
2772
|
-
def get_portfolio_properties(self, scope : Annotated[
|
2791
|
+
def get_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.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio's properties. 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 portfolio's properties. Defaults to returning the latest version of each property if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioProperties, Awaitable[PortfolioProperties]]: # noqa: E501
|
2773
2792
|
"""GetPortfolioProperties: Get portfolio properties # noqa: E501
|
2774
2793
|
|
2775
2794
|
List all the properties of a particular portfolio. # noqa: E501
|
@@ -2806,7 +2825,7 @@ class PortfoliosApi:
|
|
2806
2825
|
return self.get_portfolio_properties_with_http_info(scope, code, effective_at, as_at, **kwargs) # noqa: E501
|
2807
2826
|
|
2808
2827
|
@validate_arguments
|
2809
|
-
def get_portfolio_properties_with_http_info(self, scope : Annotated[
|
2828
|
+
def get_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.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio's properties. 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 portfolio's properties. Defaults to returning the latest version of each property if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2810
2829
|
"""GetPortfolioProperties: Get portfolio properties # noqa: E501
|
2811
2830
|
|
2812
2831
|
List all the properties of a particular portfolio. # noqa: E501
|
@@ -2938,16 +2957,17 @@ class PortfoliosApi:
|
|
2938
2957
|
collection_formats=_collection_formats,
|
2939
2958
|
_request_auth=_params.get('_request_auth'))
|
2940
2959
|
|
2960
|
+
|
2941
2961
|
@overload
|
2942
|
-
async def get_portfolio_property_time_series(self, scope : Annotated[
|
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, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
|
2943
2963
|
...
|
2944
2964
|
|
2945
2965
|
@overload
|
2946
|
-
def get_portfolio_property_time_series(self, scope : Annotated[
|
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, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
|
2947
2967
|
...
|
2948
2968
|
|
2949
2969
|
@validate_arguments
|
2950
|
-
def get_portfolio_property_time_series(self, scope : Annotated[
|
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, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
|
2951
2971
|
"""GetPortfolioPropertyTimeSeries: Get portfolio property time series # noqa: E501
|
2952
2972
|
|
2953
2973
|
Show the complete time series (history) for a particular portfolio property. # noqa: E501
|
@@ -2992,7 +3012,7 @@ class PortfoliosApi:
|
|
2992
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
|
2993
3013
|
|
2994
3014
|
@validate_arguments
|
2995
|
-
def get_portfolio_property_time_series_with_http_info(self, scope : Annotated[
|
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, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2996
3016
|
"""GetPortfolioPropertyTimeSeries: Get portfolio property time series # noqa: E501
|
2997
3017
|
|
2998
3018
|
Show the complete time series (history) for a particular portfolio property. # noqa: E501
|
@@ -3148,16 +3168,17 @@ class PortfoliosApi:
|
|
3148
3168
|
collection_formats=_collection_formats,
|
3149
3169
|
_request_auth=_params.get('_request_auth'))
|
3150
3170
|
|
3171
|
+
|
3151
3172
|
@overload
|
3152
|
-
async def get_portfolio_relations(self, scope : Annotated[
|
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
|
3153
3174
|
...
|
3154
3175
|
|
3155
3176
|
@overload
|
3156
|
-
def get_portfolio_relations(self, scope : Annotated[
|
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
|
3157
3178
|
...
|
3158
3179
|
|
3159
3180
|
@validate_arguments
|
3160
|
-
def get_portfolio_relations(self, scope : Annotated[
|
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
|
3161
3182
|
"""[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations # noqa: E501
|
3162
3183
|
|
3163
3184
|
Get relations for a particular portfolio. # noqa: E501
|
@@ -3198,7 +3219,7 @@ class PortfoliosApi:
|
|
3198
3219
|
return self.get_portfolio_relations_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
|
3199
3220
|
|
3200
3221
|
@validate_arguments
|
3201
|
-
def get_portfolio_relations_with_http_info(self, scope : Annotated[
|
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
|
3202
3223
|
"""[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations # noqa: E501
|
3203
3224
|
|
3204
3225
|
Get relations for a particular portfolio. # noqa: E501
|
@@ -3343,16 +3364,17 @@ class PortfoliosApi:
|
|
3343
3364
|
collection_formats=_collection_formats,
|
3344
3365
|
_request_auth=_params.get('_request_auth'))
|
3345
3366
|
|
3367
|
+
|
3346
3368
|
@overload
|
3347
|
-
async def get_portfolio_relationships(self, scope : Annotated[
|
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
|
3348
3370
|
...
|
3349
3371
|
|
3350
3372
|
@overload
|
3351
|
-
def get_portfolio_relationships(self, scope : Annotated[
|
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
|
3352
3374
|
...
|
3353
3375
|
|
3354
3376
|
@validate_arguments
|
3355
|
-
def get_portfolio_relationships(self, scope : Annotated[
|
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
|
3356
3378
|
"""GetPortfolioRelationships: Get portfolio relationships # noqa: E501
|
3357
3379
|
|
3358
3380
|
Get relationships for a particular portfolio. # noqa: E501
|
@@ -3393,7 +3415,7 @@ class PortfoliosApi:
|
|
3393
3415
|
return self.get_portfolio_relationships_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
|
3394
3416
|
|
3395
3417
|
@validate_arguments
|
3396
|
-
def get_portfolio_relationships_with_http_info(self, scope : Annotated[
|
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
|
3397
3419
|
"""GetPortfolioRelationships: Get portfolio relationships # noqa: E501
|
3398
3420
|
|
3399
3421
|
Get relationships for a particular portfolio. # noqa: E501
|
@@ -3538,16 +3560,17 @@ class PortfoliosApi:
|
|
3538
3560
|
collection_formats=_collection_formats,
|
3539
3561
|
_request_auth=_params.get('_request_auth'))
|
3540
3562
|
|
3563
|
+
|
3541
3564
|
@overload
|
3542
|
-
async def get_portfolio_returns(self, scope : Annotated[
|
3565
|
+
async def get_portfolio_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.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to get the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date from which to get the Returns.")] = None, period : Annotated[Optional[StrictStr], Field( description="Show the Returns on a Daily or Monthly period. Defaults to Daily.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, **kwargs) -> ResourceListOfPerformanceReturn: # noqa: E501
|
3543
3566
|
...
|
3544
3567
|
|
3545
3568
|
@overload
|
3546
|
-
def get_portfolio_returns(self, scope : Annotated[
|
3569
|
+
def get_portfolio_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.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to get the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date from which to get the Returns.")] = None, period : Annotated[Optional[StrictStr], Field( description="Show the Returns on a Daily or Monthly period. Defaults to Daily.")] = None, 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]=True, **kwargs) -> ResourceListOfPerformanceReturn: # noqa: E501
|
3547
3570
|
...
|
3548
3571
|
|
3549
3572
|
@validate_arguments
|
3550
|
-
def get_portfolio_returns(self, scope : Annotated[
|
3573
|
+
def get_portfolio_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.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to get the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date from which to get the Returns.")] = None, period : Annotated[Optional[StrictStr], Field( description="Show the Returns on a Daily or Monthly period. Defaults to Daily.")] = None, 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[ResourceListOfPerformanceReturn, Awaitable[ResourceListOfPerformanceReturn]]: # noqa: E501
|
3551
3574
|
"""GetPortfolioReturns: Get Returns # noqa: E501
|
3552
3575
|
|
3553
3576
|
Get Returns which are on the specified portfolio. # noqa: E501
|
@@ -3592,7 +3615,7 @@ class PortfoliosApi:
|
|
3592
3615
|
return self.get_portfolio_returns_with_http_info(scope, code, return_scope, return_code, from_effective_at, to_effective_at, period, as_at, **kwargs) # noqa: E501
|
3593
3616
|
|
3594
3617
|
@validate_arguments
|
3595
|
-
def get_portfolio_returns_with_http_info(self, scope : Annotated[
|
3618
|
+
def get_portfolio_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.")], from_effective_at : Annotated[Optional[StrictStr], Field( description="The start date from which to get the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field( description="The end date from which to get the Returns.")] = None, period : Annotated[Optional[StrictStr], Field( description="Show the Returns on a Daily or Monthly period. Defaults to Daily.")] = None, 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
|
3596
3619
|
"""GetPortfolioReturns: Get Returns # noqa: E501
|
3597
3620
|
|
3598
3621
|
Get Returns which are on the specified portfolio. # noqa: E501
|
@@ -3748,16 +3771,17 @@ class PortfoliosApi:
|
|
3748
3771
|
collection_formats=_collection_formats,
|
3749
3772
|
_request_auth=_params.get('_request_auth'))
|
3750
3773
|
|
3774
|
+
|
3751
3775
|
@overload
|
3752
|
-
async def get_portfolios_access_metadata_by_key(self, scope : Annotated[
|
3776
|
+
async 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, **kwargs) -> List[AccessMetadataValue]: # noqa: E501
|
3753
3777
|
...
|
3754
3778
|
|
3755
3779
|
@overload
|
3756
|
-
def get_portfolios_access_metadata_by_key(self, scope : Annotated[
|
3780
|
+
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]=True, **kwargs) -> List[AccessMetadataValue]: # noqa: E501
|
3757
3781
|
...
|
3758
3782
|
|
3759
3783
|
@validate_arguments
|
3760
|
-
def get_portfolios_access_metadata_by_key(self, scope : Annotated[
|
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
|
3761
3785
|
"""[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object # noqa: E501
|
3762
3786
|
|
3763
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
|
@@ -3796,7 +3820,7 @@ class PortfoliosApi:
|
|
3796
3820
|
return self.get_portfolios_access_metadata_by_key_with_http_info(scope, code, metadata_key, effective_at, as_at, **kwargs) # noqa: E501
|
3797
3821
|
|
3798
3822
|
@validate_arguments
|
3799
|
-
def get_portfolios_access_metadata_by_key_with_http_info(self, scope : Annotated[
|
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
|
3800
3824
|
"""[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object # noqa: E501
|
3801
3825
|
|
3802
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
|
@@ -3934,16 +3958,17 @@ class PortfoliosApi:
|
|
3934
3958
|
collection_formats=_collection_formats,
|
3935
3959
|
_request_auth=_params.get('_request_auth'))
|
3936
3960
|
|
3961
|
+
|
3937
3962
|
@overload
|
3938
|
-
async def list_instrument_event_instructions(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
3939
3964
|
...
|
3940
3965
|
|
3941
3966
|
@overload
|
3942
|
-
def list_instrument_event_instructions(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
3943
3968
|
...
|
3944
3969
|
|
3945
3970
|
@validate_arguments
|
3946
|
-
def list_instrument_event_instructions(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
3947
3972
|
"""[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions # noqa: E501
|
3948
3973
|
|
3949
3974
|
Lists all instructions for a particular portfolio # noqa: E501
|
@@ -3988,7 +4013,7 @@ class PortfoliosApi:
|
|
3988
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
|
3989
4014
|
|
3990
4015
|
@validate_arguments
|
3991
|
-
def list_instrument_event_instructions_with_http_info(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
3992
4017
|
"""[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions # noqa: E501
|
3993
4018
|
|
3994
4019
|
Lists all instructions for a particular portfolio # noqa: E501
|
@@ -4145,16 +4170,17 @@ class PortfoliosApi:
|
|
4145
4170
|
collection_formats=_collection_formats,
|
4146
4171
|
_request_auth=_params.get('_request_auth'))
|
4147
4172
|
|
4173
|
+
|
4148
4174
|
@overload
|
4149
|
-
async def list_portfolio_properties(self, scope : Annotated[
|
4175
|
+
async def list_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.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio's properties. 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 portfolio's properties. Defaults to returning the latest version of each property if not specified.")] = 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, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, **kwargs) -> ResourceListOfProperty: # noqa: E501
|
4150
4176
|
...
|
4151
4177
|
|
4152
4178
|
@overload
|
4153
|
-
def list_portfolio_properties(self, scope : Annotated[
|
4179
|
+
def list_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.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio's properties. 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 portfolio's properties. Defaults to returning the latest version of each property if not specified.")] = 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, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfProperty: # noqa: E501
|
4154
4180
|
...
|
4155
4181
|
|
4156
4182
|
@validate_arguments
|
4157
|
-
def list_portfolio_properties(self, scope : Annotated[
|
4183
|
+
def list_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.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio's properties. 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 portfolio's properties. Defaults to returning the latest version of each property if not specified.")] = 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, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfProperty, Awaitable[ResourceListOfProperty]]: # noqa: E501
|
4158
4184
|
"""[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties # noqa: E501
|
4159
4185
|
|
4160
4186
|
List all the properties of a particular portfolio. # noqa: E501
|
@@ -4195,7 +4221,7 @@ class PortfoliosApi:
|
|
4195
4221
|
return self.list_portfolio_properties_with_http_info(scope, code, effective_at, as_at, page, limit, **kwargs) # noqa: E501
|
4196
4222
|
|
4197
4223
|
@validate_arguments
|
4198
|
-
def list_portfolio_properties_with_http_info(self, scope : Annotated[
|
4224
|
+
def list_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.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio's properties. 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 portfolio's properties. Defaults to returning the latest version of each property if not specified.")] = 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, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4199
4225
|
"""[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties # noqa: E501
|
4200
4226
|
|
4201
4227
|
List all the properties of a particular portfolio. # noqa: E501
|
@@ -4339,16 +4365,17 @@ class PortfoliosApi:
|
|
4339
4365
|
collection_formats=_collection_formats,
|
4340
4366
|
_request_auth=_params.get('_request_auth'))
|
4341
4367
|
|
4368
|
+
|
4342
4369
|
@overload
|
4343
|
-
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[
|
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, le=5000, ge=1)], 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
|
4344
4371
|
...
|
4345
4372
|
|
4346
4373
|
@overload
|
4347
|
-
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[
|
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, le=5000, ge=1)], 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
|
4348
4375
|
...
|
4349
4376
|
|
4350
4377
|
@validate_arguments
|
4351
|
-
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[
|
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, le=5000, ge=1)], 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
|
4352
4379
|
"""ListPortfolios: List portfolios # noqa: E501
|
4353
4380
|
|
4354
4381
|
List all the portfolios matching particular criteria. # noqa: E501
|
@@ -4395,7 +4422,7 @@ class PortfoliosApi:
|
|
4395
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
|
4396
4423
|
|
4397
4424
|
@validate_arguments
|
4398
|
-
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[
|
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, le=5000, ge=1)], 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
|
4399
4426
|
"""ListPortfolios: List portfolios # noqa: E501
|
4400
4427
|
|
4401
4428
|
List all the portfolios matching particular criteria. # noqa: E501
|
@@ -4560,16 +4587,17 @@ class PortfoliosApi:
|
|
4560
4587
|
collection_formats=_collection_formats,
|
4561
4588
|
_request_auth=_params.get('_request_auth'))
|
4562
4589
|
|
4590
|
+
|
4563
4591
|
@overload
|
4564
|
-
async def list_portfolios_for_scope(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
4565
4593
|
...
|
4566
4594
|
|
4567
4595
|
@overload
|
4568
|
-
def list_portfolios_for_scope(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
4569
4597
|
...
|
4570
4598
|
|
4571
4599
|
@validate_arguments
|
4572
|
-
def list_portfolios_for_scope(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
4573
4601
|
"""ListPortfoliosForScope: List portfolios for scope # noqa: E501
|
4574
4602
|
|
4575
4603
|
List all the portfolios in a particular scope. # noqa: E501
|
@@ -4616,7 +4644,7 @@ class PortfoliosApi:
|
|
4616
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
|
4617
4645
|
|
4618
4646
|
@validate_arguments
|
4619
|
-
def list_portfolios_for_scope_with_http_info(self, scope : Annotated[
|
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, le=5000, ge=1)], 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
|
4620
4648
|
"""ListPortfoliosForScope: List portfolios for scope # noqa: E501
|
4621
4649
|
|
4622
4650
|
List all the portfolios in a particular scope. # noqa: E501
|
@@ -4781,16 +4809,17 @@ class PortfoliosApi:
|
|
4781
4809
|
collection_formats=_collection_formats,
|
4782
4810
|
_request_auth=_params.get('_request_auth'))
|
4783
4811
|
|
4812
|
+
|
4784
4813
|
@overload
|
4785
|
-
async def patch_portfolio(self, scope : Annotated[
|
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
|
4786
4815
|
...
|
4787
4816
|
|
4788
4817
|
@overload
|
4789
|
-
def patch_portfolio(self, scope : Annotated[
|
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
|
4790
4819
|
...
|
4791
4820
|
|
4792
4821
|
@validate_arguments
|
4793
|
-
def patch_portfolio(self, scope : Annotated[
|
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
|
4794
4823
|
"""PatchPortfolio: Patch portfolio. # noqa: E501
|
4795
4824
|
|
4796
4825
|
Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: Created, InstrumentScopes, Type. # noqa: E501
|
@@ -4825,7 +4854,7 @@ class PortfoliosApi:
|
|
4825
4854
|
return self.patch_portfolio_with_http_info(scope, code, operation, **kwargs) # noqa: E501
|
4826
4855
|
|
4827
4856
|
@validate_arguments
|
4828
|
-
def patch_portfolio_with_http_info(self, scope : Annotated[
|
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
|
4829
4858
|
"""PatchPortfolio: Patch portfolio. # noqa: E501
|
4830
4859
|
|
4831
4860
|
Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: Created, InstrumentScopes, Type. # noqa: E501
|
@@ -4955,16 +4984,17 @@ class PortfoliosApi:
|
|
4955
4984
|
collection_formats=_collection_formats,
|
4956
4985
|
_request_auth=_params.get('_request_auth'))
|
4957
4986
|
|
4987
|
+
|
4958
4988
|
@overload
|
4959
|
-
async def patch_portfolio_access_metadata(self, scope : Annotated[
|
4989
|
+
async 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, **kwargs) -> Dict[str, List[AccessMetadataValue]]: # noqa: E501
|
4960
4990
|
...
|
4961
4991
|
|
4962
4992
|
@overload
|
4963
|
-
def patch_portfolio_access_metadata(self, scope : Annotated[
|
4993
|
+
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]=True, **kwargs) -> Dict[str, List[AccessMetadataValue]]: # noqa: E501
|
4964
4994
|
...
|
4965
4995
|
|
4966
4996
|
@validate_arguments
|
4967
|
-
def patch_portfolio_access_metadata(self, scope : Annotated[
|
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
|
4968
4998
|
"""[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. # noqa: E501
|
4969
4999
|
|
4970
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
|
@@ -5003,7 +5033,7 @@ class PortfoliosApi:
|
|
5003
5033
|
return self.patch_portfolio_access_metadata_with_http_info(scope, code, access_metadata_operation, effective_at, effective_until, **kwargs) # noqa: E501
|
5004
5034
|
|
5005
5035
|
@validate_arguments
|
5006
|
-
def patch_portfolio_access_metadata_with_http_info(self, scope : Annotated[
|
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
|
5007
5037
|
"""[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. # noqa: E501
|
5008
5038
|
|
5009
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
|
@@ -5148,16 +5178,17 @@ class PortfoliosApi:
|
|
5148
5178
|
collection_formats=_collection_formats,
|
5149
5179
|
_request_auth=_params.get('_request_auth'))
|
5150
5180
|
|
5181
|
+
|
5151
5182
|
@overload
|
5152
|
-
async def update_portfolio(self, scope : Annotated[
|
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
|
5153
5184
|
...
|
5154
5185
|
|
5155
5186
|
@overload
|
5156
|
-
def update_portfolio(self, scope : Annotated[
|
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
|
5157
5188
|
...
|
5158
5189
|
|
5159
5190
|
@validate_arguments
|
5160
|
-
def update_portfolio(self, scope : Annotated[
|
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
|
5161
5192
|
"""UpdatePortfolio: Update portfolio # noqa: E501
|
5162
5193
|
|
5163
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
|
@@ -5194,7 +5225,7 @@ class PortfoliosApi:
|
|
5194
5225
|
return self.update_portfolio_with_http_info(scope, code, update_portfolio_request, effective_at, **kwargs) # noqa: E501
|
5195
5226
|
|
5196
5227
|
@validate_arguments
|
5197
|
-
def update_portfolio_with_http_info(self, scope : Annotated[
|
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
|
5198
5229
|
"""UpdatePortfolio: Update portfolio # noqa: E501
|
5199
5230
|
|
5200
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
|
@@ -5330,16 +5361,17 @@ class PortfoliosApi:
|
|
5330
5361
|
collection_formats=_collection_formats,
|
5331
5362
|
_request_auth=_params.get('_request_auth'))
|
5332
5363
|
|
5364
|
+
|
5333
5365
|
@overload
|
5334
|
-
async def upsert_instrument_event_instructions(self, scope : Annotated[
|
5366
|
+
async def upsert_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.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)")], request_body : Annotated[Dict[str, InstrumentEventInstructionRequest], Field(..., description="The instructions to be upserted to 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, **kwargs) -> InstrumentEventInstructionsResponse: # noqa: E501
|
5335
5367
|
...
|
5336
5368
|
|
5337
5369
|
@overload
|
5338
|
-
def upsert_instrument_event_instructions(self, scope : Annotated[
|
5370
|
+
def upsert_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.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)")], request_body : Annotated[Dict[str, InstrumentEventInstructionRequest], Field(..., description="The instructions to be upserted to 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, async_req: Optional[bool]=True, **kwargs) -> InstrumentEventInstructionsResponse: # noqa: E501
|
5339
5371
|
...
|
5340
5372
|
|
5341
5373
|
@validate_arguments
|
5342
|
-
def upsert_instrument_event_instructions(self, scope : Annotated[
|
5374
|
+
def upsert_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.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)")], request_body : Annotated[Dict[str, InstrumentEventInstructionRequest], Field(..., description="The instructions to be upserted to 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, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentEventInstructionsResponse, Awaitable[InstrumentEventInstructionsResponse]]: # noqa: E501
|
5343
5375
|
"""[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions # noqa: E501
|
5344
5376
|
|
5345
5377
|
Batch upsert for instrument event instructions, for the portfolio or individual holdings # noqa: E501
|
@@ -5378,7 +5410,7 @@ class PortfoliosApi:
|
|
5378
5410
|
return self.upsert_instrument_event_instructions_with_http_info(scope, code, success_mode, request_body, portfolio_effective_at, **kwargs) # noqa: E501
|
5379
5411
|
|
5380
5412
|
@validate_arguments
|
5381
|
-
def upsert_instrument_event_instructions_with_http_info(self, scope : Annotated[
|
5413
|
+
def upsert_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.")], success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)")], request_body : Annotated[Dict[str, InstrumentEventInstructionRequest], Field(..., description="The instructions to be upserted to 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, **kwargs) -> ApiResponse: # noqa: E501
|
5382
5414
|
"""[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions # noqa: E501
|
5383
5415
|
|
5384
5416
|
Batch upsert for instrument event instructions, for the portfolio or individual holdings # noqa: E501
|
@@ -5520,16 +5552,17 @@ class PortfoliosApi:
|
|
5520
5552
|
collection_formats=_collection_formats,
|
5521
5553
|
_request_auth=_params.get('_request_auth'))
|
5522
5554
|
|
5555
|
+
|
5523
5556
|
@overload
|
5524
|
-
async def upsert_portfolio_access_metadata(self, scope : Annotated[
|
5557
|
+
async 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, **kwargs) -> ResourceListOfAccessMetadataValueOf: # noqa: E501
|
5525
5558
|
...
|
5526
5559
|
|
5527
5560
|
@overload
|
5528
|
-
def upsert_portfolio_access_metadata(self, scope : Annotated[
|
5561
|
+
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]=True, **kwargs) -> ResourceListOfAccessMetadataValueOf: # noqa: E501
|
5529
5562
|
...
|
5530
5563
|
|
5531
5564
|
@validate_arguments
|
5532
|
-
def upsert_portfolio_access_metadata(self, scope : Annotated[
|
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
|
5533
5566
|
"""UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
5534
5567
|
|
5535
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
|
@@ -5570,7 +5603,7 @@ class PortfoliosApi:
|
|
5570
5603
|
return self.upsert_portfolio_access_metadata_with_http_info(scope, code, metadata_key, upsert_portfolio_access_metadata_request, effective_at, effective_until, **kwargs) # noqa: E501
|
5571
5604
|
|
5572
5605
|
@validate_arguments
|
5573
|
-
def upsert_portfolio_access_metadata_with_http_info(self, scope : Annotated[
|
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
|
5574
5607
|
"""UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
5575
5608
|
|
5576
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
|
@@ -5721,16 +5754,17 @@ class PortfoliosApi:
|
|
5721
5754
|
collection_formats=_collection_formats,
|
5722
5755
|
_request_auth=_params.get('_request_auth'))
|
5723
5756
|
|
5757
|
+
|
5724
5758
|
@overload
|
5725
|
-
async def upsert_portfolio_properties(self, scope : Annotated[
|
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
|
5726
5760
|
...
|
5727
5761
|
|
5728
5762
|
@overload
|
5729
|
-
def upsert_portfolio_properties(self, scope : Annotated[
|
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
|
5730
5764
|
...
|
5731
5765
|
|
5732
5766
|
@validate_arguments
|
5733
|
-
def upsert_portfolio_properties(self, scope : Annotated[
|
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
|
5734
5768
|
"""UpsertPortfolioProperties: Upsert portfolio properties # noqa: E501
|
5735
5769
|
|
5736
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
|
@@ -5765,7 +5799,7 @@ class PortfoliosApi:
|
|
5765
5799
|
return self.upsert_portfolio_properties_with_http_info(scope, code, request_body, **kwargs) # noqa: E501
|
5766
5800
|
|
5767
5801
|
@validate_arguments
|
5768
|
-
def upsert_portfolio_properties_with_http_info(self, scope : Annotated[
|
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
|
5769
5803
|
"""UpsertPortfolioProperties: Upsert portfolio properties # noqa: E501
|
5770
5804
|
|
5771
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
|
@@ -5895,16 +5929,17 @@ class PortfoliosApi:
|
|
5895
5929
|
collection_formats=_collection_formats,
|
5896
5930
|
_request_auth=_params.get('_request_auth'))
|
5897
5931
|
|
5932
|
+
|
5898
5933
|
@overload
|
5899
|
-
async def upsert_portfolio_returns(self, scope : Annotated[
|
5934
|
+
async def upsert_portfolio_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.")], performance_return : Annotated[conlist(PerformanceReturn), Field(..., description="This contains the Returns which need to be upsert.")], **kwargs) -> UpsertReturnsResponse: # noqa: E501
|
5900
5935
|
...
|
5901
5936
|
|
5902
5937
|
@overload
|
5903
|
-
def upsert_portfolio_returns(self, scope : Annotated[
|
5938
|
+
def upsert_portfolio_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.")], performance_return : Annotated[conlist(PerformanceReturn), Field(..., description="This contains the Returns which need to be upsert.")], async_req: Optional[bool]=True, **kwargs) -> UpsertReturnsResponse: # noqa: E501
|
5904
5939
|
...
|
5905
5940
|
|
5906
5941
|
@validate_arguments
|
5907
|
-
def upsert_portfolio_returns(self, scope : Annotated[
|
5942
|
+
def upsert_portfolio_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.")], performance_return : Annotated[conlist(PerformanceReturn), Field(..., description="This contains the Returns which need to be upsert.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertReturnsResponse, Awaitable[UpsertReturnsResponse]]: # noqa: E501
|
5908
5943
|
"""UpsertPortfolioReturns: Upsert Returns # noqa: E501
|
5909
5944
|
|
5910
5945
|
Update or insert returns into the specified portfolio. # noqa: E501
|
@@ -5943,7 +5978,7 @@ class PortfoliosApi:
|
|
5943
5978
|
return self.upsert_portfolio_returns_with_http_info(scope, code, return_scope, return_code, performance_return, **kwargs) # noqa: E501
|
5944
5979
|
|
5945
5980
|
@validate_arguments
|
5946
|
-
def upsert_portfolio_returns_with_http_info(self, scope : Annotated[
|
5981
|
+
def upsert_portfolio_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.")], performance_return : Annotated[conlist(PerformanceReturn), Field(..., description="This contains the Returns which need to be upsert.")], **kwargs) -> ApiResponse: # noqa: E501
|
5947
5982
|
"""UpsertPortfolioReturns: Upsert Returns # noqa: E501
|
5948
5983
|
|
5949
5984
|
Update or insert returns into the specified portfolio. # noqa: E501
|