lusid-sdk 2.1.913__py3-none-any.whl → 2.1.914__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +139 -130
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_calendar_entry.py +21 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +1 -1
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_fund_bookmark_request.py +3 -3
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/WHEEL +0 -0
@@ -442,18 +442,18 @@ class PortfolioGroupsApi:
|
|
442
442
|
|
443
443
|
|
444
444
|
@overload
|
445
|
-
async def build_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
445
|
+
async def build_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], transaction_query_parameters : Annotated[TransactionQueryParameters, Field(..., description="The query queryParameters which control how the output transactions are built.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to BuildTransactions.")] = None, **kwargs) -> VersionedResourceListOfOutputTransaction: # noqa: E501
|
446
446
|
...
|
447
447
|
|
448
448
|
@overload
|
449
|
-
def build_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
449
|
+
def build_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], transaction_query_parameters : Annotated[TransactionQueryParameters, Field(..., description="The query queryParameters which control how the output transactions are built.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to BuildTransactions.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfOutputTransaction: # noqa: E501
|
450
450
|
...
|
451
451
|
|
452
452
|
@validate_arguments
|
453
|
-
def build_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
453
|
+
def build_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], transaction_query_parameters : Annotated[TransactionQueryParameters, Field(..., description="The query queryParameters which control how the output transactions are built.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to BuildTransactions.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfOutputTransaction, Awaitable[VersionedResourceListOfOutputTransaction]]: # noqa: E501
|
454
454
|
"""BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group # noqa: E501
|
455
455
|
|
456
|
-
Build transactions for transaction portfolios in a portfolio group over a given interval of effective time.
|
456
|
+
Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. # noqa: E501
|
457
457
|
This method makes a synchronous HTTP request by default. To make an
|
458
458
|
asynchronous HTTP request, please pass async_req=True
|
459
459
|
|
@@ -462,15 +462,15 @@ class PortfolioGroupsApi:
|
|
462
462
|
|
463
463
|
:param scope: The scope of the portfolio group. (required)
|
464
464
|
:type scope: str
|
465
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
465
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
466
466
|
:type code: str
|
467
467
|
:param transaction_query_parameters: The query queryParameters which control how the output transactions are built. (required)
|
468
468
|
:type transaction_query_parameters: TransactionQueryParameters
|
469
|
-
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest
|
469
|
+
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
|
470
470
|
:type as_at: datetime
|
471
|
-
:param filter: Expression to filter the result set.
|
471
|
+
:param filter: Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
472
472
|
:type filter: str
|
473
|
-
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto
|
473
|
+
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
474
474
|
:type property_keys: List[str]
|
475
475
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
476
476
|
:type limit: int
|
@@ -495,10 +495,10 @@ class PortfolioGroupsApi:
|
|
495
495
|
return self.build_transactions_for_portfolio_group_with_http_info(scope, code, transaction_query_parameters, as_at, filter, property_keys, limit, page, **kwargs) # noqa: E501
|
496
496
|
|
497
497
|
@validate_arguments
|
498
|
-
def build_transactions_for_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
498
|
+
def build_transactions_for_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], transaction_query_parameters : Annotated[TransactionQueryParameters, Field(..., description="The query queryParameters which control how the output transactions are built.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to BuildTransactions.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
499
499
|
"""BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group # noqa: E501
|
500
500
|
|
501
|
-
Build transactions for transaction portfolios in a portfolio group over a given interval of effective time.
|
501
|
+
Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. # noqa: E501
|
502
502
|
This method makes a synchronous HTTP request by default. To make an
|
503
503
|
asynchronous HTTP request, please pass async_req=True
|
504
504
|
|
@@ -507,15 +507,15 @@ class PortfolioGroupsApi:
|
|
507
507
|
|
508
508
|
:param scope: The scope of the portfolio group. (required)
|
509
509
|
:type scope: str
|
510
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
510
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
511
511
|
:type code: str
|
512
512
|
:param transaction_query_parameters: The query queryParameters which control how the output transactions are built. (required)
|
513
513
|
:type transaction_query_parameters: TransactionQueryParameters
|
514
|
-
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest
|
514
|
+
:param as_at: The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.
|
515
515
|
:type as_at: datetime
|
516
|
-
:param filter: Expression to filter the result set.
|
516
|
+
:param filter: Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
517
517
|
:type filter: str
|
518
|
-
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto
|
518
|
+
:param property_keys: A list of property keys from the \"Instrument\" or \"Transaction\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
519
519
|
:type property_keys: List[str]
|
520
520
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
521
521
|
:type limit: int
|
@@ -828,18 +828,18 @@ class PortfolioGroupsApi:
|
|
828
828
|
|
829
829
|
|
830
830
|
@overload
|
831
|
-
async def delete_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the group to delete properties from. Together with the scope this uniquely identifies the group.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These take the format
|
831
|
+
async def delete_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the group to delete properties from. Together with the scope this uniquely identifies the group.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" 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
|
832
832
|
...
|
833
833
|
|
834
834
|
@overload
|
835
|
-
def delete_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the group to delete properties from. Together with the scope this uniquely identifies the group.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These take the format
|
835
|
+
def delete_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the group to delete properties from. Together with the scope this uniquely identifies the group.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" 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
|
836
836
|
...
|
837
837
|
|
838
838
|
@validate_arguments
|
839
|
-
def delete_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the group to delete properties from. Together with the scope this uniquely identifies the group.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These take the format
|
839
|
+
def delete_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the group to delete properties from. Together with the scope this uniquely identifies the group.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" 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
|
840
840
|
"""[EARLY ACCESS] DeleteGroupProperties: Delete group properties # noqa: E501
|
841
841
|
|
842
|
-
Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties
|
842
|
+
Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. # noqa: E501
|
843
843
|
This method makes a synchronous HTTP request by default. To make an
|
844
844
|
asynchronous HTTP request, please pass async_req=True
|
845
845
|
|
@@ -850,9 +850,9 @@ class PortfolioGroupsApi:
|
|
850
850
|
:type scope: str
|
851
851
|
:param code: The code of the group to delete properties from. Together with the scope this uniquely identifies the group. (required)
|
852
852
|
:type code: str
|
853
|
-
:param request_body: The property keys of the properties to delete. These take the format
|
853
|
+
:param request_body: The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" domain. (required)
|
854
854
|
:type request_body: List[str]
|
855
|
-
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from.
|
855
|
+
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
|
856
856
|
:type effective_at: str
|
857
857
|
:param async_req: Whether to execute the request asynchronously.
|
858
858
|
:type async_req: bool, optional
|
@@ -873,10 +873,10 @@ class PortfolioGroupsApi:
|
|
873
873
|
return self.delete_group_properties_with_http_info(scope, code, request_body, effective_at, **kwargs) # noqa: E501
|
874
874
|
|
875
875
|
@validate_arguments
|
876
|
-
def delete_group_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the group to delete properties from. Together with the scope this uniquely identifies the group.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These take the format
|
876
|
+
def delete_group_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the group to delete properties from. Together with the scope this uniquely identifies the group.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" 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
|
877
877
|
"""[EARLY ACCESS] DeleteGroupProperties: Delete group properties # noqa: E501
|
878
878
|
|
879
|
-
Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties
|
879
|
+
Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. # noqa: E501
|
880
880
|
This method makes a synchronous HTTP request by default. To make an
|
881
881
|
asynchronous HTTP request, please pass async_req=True
|
882
882
|
|
@@ -887,9 +887,9 @@ class PortfolioGroupsApi:
|
|
887
887
|
:type scope: str
|
888
888
|
:param code: The code of the group to delete properties from. Together with the scope this uniquely identifies the group. (required)
|
889
889
|
:type code: str
|
890
|
-
:param request_body: The property keys of the properties to delete. These take the format
|
890
|
+
:param request_body: The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" domain. (required)
|
891
891
|
:type request_body: List[str]
|
892
|
-
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from.
|
892
|
+
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
|
893
893
|
:type effective_at: str
|
894
894
|
:param async_req: Whether to execute the request asynchronously.
|
895
895
|
:type async_req: bool, optional
|
@@ -1022,7 +1022,7 @@ class PortfolioGroupsApi:
|
|
1022
1022
|
def delete_key_from_portfolio_group_access_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Group")], code : Annotated[StrictStr, Field(..., description="The Portfolio Group code")], metadata_key : Annotated[StrictStr, Field(..., description="Key of 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
|
1023
1023
|
"""[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry # noqa: E501
|
1024
1024
|
|
1025
|
-
Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts.
|
1025
|
+
Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
|
1026
1026
|
This method makes a synchronous HTTP request by default. To make an
|
1027
1027
|
asynchronous HTTP request, please pass async_req=True
|
1028
1028
|
|
@@ -1061,7 +1061,7 @@ class PortfolioGroupsApi:
|
|
1061
1061
|
def delete_key_from_portfolio_group_access_metadata_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Group")], code : Annotated[StrictStr, Field(..., description="The Portfolio Group code")], metadata_key : Annotated[StrictStr, Field(..., description="Key of 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
|
1062
1062
|
"""[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry # noqa: E501
|
1063
1063
|
|
1064
|
-
Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts.
|
1064
|
+
Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
|
1065
1065
|
This method makes a synchronous HTTP request by default. To make an
|
1066
1066
|
asynchronous HTTP request, please pass async_req=True
|
1067
1067
|
|
@@ -1393,7 +1393,7 @@ class PortfolioGroupsApi:
|
|
1393
1393
|
def delete_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to delete.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
1394
1394
|
"""[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group # noqa: E501
|
1395
1395
|
|
1396
|
-
Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups.
|
1396
|
+
Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
1397
1397
|
This method makes a synchronous HTTP request by default. To make an
|
1398
1398
|
asynchronous HTTP request, please pass async_req=True
|
1399
1399
|
|
@@ -1426,7 +1426,7 @@ class PortfolioGroupsApi:
|
|
1426
1426
|
def delete_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to delete.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete.")], **kwargs) -> ApiResponse: # noqa: E501
|
1427
1427
|
"""[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group # noqa: E501
|
1428
1428
|
|
1429
|
-
Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups.
|
1429
|
+
Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
1430
1430
|
This method makes a synchronous HTTP request by default. To make an
|
1431
1431
|
asynchronous HTTP request, please pass async_req=True
|
1432
1432
|
|
@@ -1726,15 +1726,15 @@ class PortfolioGroupsApi:
|
|
1726
1726
|
|
1727
1727
|
|
1728
1728
|
@overload
|
1729
|
-
async def get_a2_b_data_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the group to retrieve the A2B report for. Together with the scope this
|
1729
|
+
async def get_a2_b_data_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> VersionedResourceListOfA2BDataRecord: # noqa: E501
|
1730
1730
|
...
|
1731
1731
|
|
1732
1732
|
@overload
|
1733
|
-
def get_a2_b_data_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the group to retrieve the A2B report for. Together with the scope this
|
1733
|
+
def get_a2_b_data_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfA2BDataRecord: # noqa: E501
|
1734
1734
|
...
|
1735
1735
|
|
1736
1736
|
@validate_arguments
|
1737
|
-
def get_a2_b_data_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the group to retrieve the A2B report for. Together with the scope this
|
1737
|
+
def get_a2_b_data_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfA2BDataRecord, Awaitable[VersionedResourceListOfA2BDataRecord]]: # noqa: E501
|
1738
1738
|
"""[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group # noqa: E501
|
1739
1739
|
|
1740
1740
|
Get an A2B report for all Transaction Portfolios within the given portfolio group. # noqa: E501
|
@@ -1746,21 +1746,21 @@ class PortfolioGroupsApi:
|
|
1746
1746
|
|
1747
1747
|
:param scope: The scope of the group to retrieve the A2B report for. (required)
|
1748
1748
|
:type scope: str
|
1749
|
-
:param code: The code of the group to retrieve the A2B report for. Together with the scope this
|
1749
|
+
:param code: The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. (required)
|
1750
1750
|
:type code: str
|
1751
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
1751
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
1752
1752
|
:type from_effective_at: str
|
1753
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
1753
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
1754
1754
|
:type to_effective_at: str
|
1755
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version
|
1755
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.
|
1756
1756
|
:type as_at: datetime
|
1757
1757
|
:param recipe_id_scope: The scope of the given recipeId
|
1758
1758
|
:type recipe_id_scope: str
|
1759
1759
|
:param recipe_id_code: The code of the given recipeId
|
1760
1760
|
:type recipe_id_code: str
|
1761
|
-
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto
|
1761
|
+
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".
|
1762
1762
|
:type property_keys: List[str]
|
1763
|
-
:param filter: Expression to filter the result set.
|
1763
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
1764
1764
|
:type filter: str
|
1765
1765
|
:param async_req: Whether to execute the request asynchronously.
|
1766
1766
|
:type async_req: bool, optional
|
@@ -1781,7 +1781,7 @@ class PortfolioGroupsApi:
|
|
1781
1781
|
return self.get_a2_b_data_for_portfolio_group_with_http_info(scope, code, from_effective_at, to_effective_at, as_at, recipe_id_scope, recipe_id_code, property_keys, filter, **kwargs) # noqa: E501
|
1782
1782
|
|
1783
1783
|
@validate_arguments
|
1784
|
-
def get_a2_b_data_for_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the group to retrieve the A2B report for. Together with the scope this
|
1784
|
+
def get_a2_b_data_for_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to retrieve the A2B report for.")], code : Annotated[StrictStr, Field(..., description="The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group.")], from_effective_at : Annotated[StrictStr, Field(..., description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.")], to_effective_at : Annotated[StrictStr, Field(..., description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.")] = None, recipe_id_scope : Annotated[Optional[StrictStr], Field( description="The scope of the given recipeId")] = None, recipe_id_code : Annotated[Optional[StrictStr], Field( description="The code of the given recipeId")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1785
1785
|
"""[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group # noqa: E501
|
1786
1786
|
|
1787
1787
|
Get an A2B report for all Transaction Portfolios within the given portfolio group. # noqa: E501
|
@@ -1793,21 +1793,21 @@ class PortfolioGroupsApi:
|
|
1793
1793
|
|
1794
1794
|
:param scope: The scope of the group to retrieve the A2B report for. (required)
|
1795
1795
|
:type scope: str
|
1796
|
-
:param code: The code of the group to retrieve the A2B report for. Together with the scope this
|
1796
|
+
:param code: The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. (required)
|
1797
1797
|
:type code: str
|
1798
|
-
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
1798
|
+
:param from_effective_at: The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (required)
|
1799
1799
|
:type from_effective_at: str
|
1800
|
-
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data.
|
1800
|
+
:param to_effective_at: The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. (required)
|
1801
1801
|
:type to_effective_at: str
|
1802
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version
|
1802
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.
|
1803
1803
|
:type as_at: datetime
|
1804
1804
|
:param recipe_id_scope: The scope of the given recipeId
|
1805
1805
|
:type recipe_id_scope: str
|
1806
1806
|
:param recipe_id_code: The code of the given recipeId
|
1807
1807
|
:type recipe_id_code: str
|
1808
|
-
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto
|
1808
|
+
:param property_keys: A list of property keys from the \"Instrument\" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\".
|
1809
1809
|
:type property_keys: List[str]
|
1810
|
-
:param filter: Expression to filter the result set.
|
1810
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
1811
1811
|
:type filter: str
|
1812
1812
|
:param async_req: Whether to execute the request asynchronously.
|
1813
1813
|
:type async_req: bool, optional
|
@@ -2125,15 +2125,15 @@ class PortfolioGroupsApi:
|
|
2125
2125
|
|
2126
2126
|
|
2127
2127
|
@overload
|
2128
|
-
async def get_holdings_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
2128
|
+
async def get_holdings_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. 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 holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, **kwargs) -> VersionedResourceListOfPortfolioHolding: # noqa: E501
|
2129
2129
|
...
|
2130
2130
|
|
2131
2131
|
@overload
|
2132
|
-
def get_holdings_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
2132
|
+
def get_holdings_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. 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 holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfPortfolioHolding: # noqa: E501
|
2133
2133
|
...
|
2134
2134
|
|
2135
2135
|
@validate_arguments
|
2136
|
-
def get_holdings_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
2136
|
+
def get_holdings_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. 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 holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfPortfolioHolding, Awaitable[VersionedResourceListOfPortfolioHolding]]: # noqa: E501
|
2137
2137
|
"""GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group # noqa: E501
|
2138
2138
|
|
2139
2139
|
Get the holdings of transaction portfolios in specified portfolio group. # noqa: E501
|
@@ -2145,17 +2145,17 @@ class PortfolioGroupsApi:
|
|
2145
2145
|
|
2146
2146
|
:param scope: The scope of the portfolio group. (required)
|
2147
2147
|
:type scope: str
|
2148
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
2148
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
2149
2149
|
:type code: str
|
2150
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of transaction
|
2150
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified.
|
2151
2151
|
:type effective_at: str
|
2152
|
-
:param as_at: The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults
|
2152
|
+
:param as_at: The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified.
|
2153
2153
|
:type as_at: datetime
|
2154
2154
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2155
2155
|
:type filter: str
|
2156
|
-
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto
|
2156
|
+
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".
|
2157
2157
|
:type property_keys: List[str]
|
2158
|
-
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to
|
2158
|
+
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.
|
2159
2159
|
:type by_taxlots: bool
|
2160
2160
|
:param include_settlement_events_after_days: Number of days ahead to bring back settlements from, in relation to the specified effectiveAt
|
2161
2161
|
:type include_settlement_events_after_days: int
|
@@ -2178,7 +2178,7 @@ class PortfolioGroupsApi:
|
|
2178
2178
|
return self.get_holdings_for_portfolio_group_with_http_info(scope, code, effective_at, as_at, filter, property_keys, by_taxlots, include_settlement_events_after_days, **kwargs) # noqa: E501
|
2179
2179
|
|
2180
2180
|
@validate_arguments
|
2181
|
-
def get_holdings_for_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
2181
|
+
def get_holdings_for_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. 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 holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".")] = None, by_taxlots : Annotated[Optional[StrictBool], Field(description="Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.")] = None, include_settlement_events_after_days : Annotated[Optional[StrictInt], Field(description="Number of days ahead to bring back settlements from, in relation to the specified effectiveAt")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2182
2182
|
"""GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group # noqa: E501
|
2183
2183
|
|
2184
2184
|
Get the holdings of transaction portfolios in specified portfolio group. # noqa: E501
|
@@ -2190,17 +2190,17 @@ class PortfolioGroupsApi:
|
|
2190
2190
|
|
2191
2191
|
:param scope: The scope of the portfolio group. (required)
|
2192
2192
|
:type scope: str
|
2193
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
2193
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
2194
2194
|
:type code: str
|
2195
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of transaction
|
2195
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified.
|
2196
2196
|
:type effective_at: str
|
2197
|
-
:param as_at: The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults
|
2197
|
+
:param as_at: The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified.
|
2198
2198
|
:type as_at: datetime
|
2199
2199
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2200
2200
|
:type filter: str
|
2201
|
-
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto
|
2201
|
+
:param property_keys: A list of property keys from the \"Instrument\", \"Holding\" or \"Portfolio\" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Holding/system/Cost\".
|
2202
2202
|
:type property_keys: List[str]
|
2203
|
-
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to
|
2203
|
+
:param by_taxlots: Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.
|
2204
2204
|
:type by_taxlots: bool
|
2205
2205
|
:param include_settlement_events_after_days: Number of days ahead to bring back settlements from, in relation to the specified effectiveAt
|
2206
2206
|
:type include_settlement_events_after_days: int
|
@@ -2337,15 +2337,15 @@ class PortfolioGroupsApi:
|
|
2337
2337
|
|
2338
2338
|
|
2339
2339
|
@overload
|
2340
|
-
async def get_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the definition for. Together with the scope
|
2340
|
+
async def get_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio group 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 group definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys 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 group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> PortfolioGroup: # noqa: E501
|
2341
2341
|
...
|
2342
2342
|
|
2343
2343
|
@overload
|
2344
|
-
def get_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the definition for. Together with the scope
|
2344
|
+
def get_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio group 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 group definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys 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 group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> PortfolioGroup: # noqa: E501
|
2345
2345
|
...
|
2346
2346
|
|
2347
2347
|
@validate_arguments
|
2348
|
-
def get_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the definition for. Together with the scope
|
2348
|
+
def get_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio group 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 group definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys 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 group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioGroup, Awaitable[PortfolioGroup]]: # noqa: E501
|
2349
2349
|
"""GetPortfolioGroup: Get portfolio group # noqa: E501
|
2350
2350
|
|
2351
2351
|
Retrieve the definition of a single portfolio group. # noqa: E501
|
@@ -2357,15 +2357,15 @@ class PortfolioGroupsApi:
|
|
2357
2357
|
|
2358
2358
|
:param scope: The scope of the portfolio group to retrieve the definition for. (required)
|
2359
2359
|
:type scope: str
|
2360
|
-
:param code: The code of the portfolio group to retrieve the definition for. Together with the scope
|
2360
|
+
:param code: The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. (required)
|
2361
2361
|
:type code: str
|
2362
2362
|
:param effective_at: The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified.
|
2363
2363
|
:type effective_at: str
|
2364
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio group definition. Defaults to return
|
2364
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified.
|
2365
2365
|
:type as_at: datetime
|
2366
|
-
:param related_entity_property_keys: A list of property keys from any domain that supports relationships
|
2366
|
+
:param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
2367
2367
|
:type related_entity_property_keys: List[str]
|
2368
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
2368
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
2369
2369
|
:type relationship_definition_ids: List[str]
|
2370
2370
|
:param async_req: Whether to execute the request asynchronously.
|
2371
2371
|
:type async_req: bool, optional
|
@@ -2386,7 +2386,7 @@ class PortfolioGroupsApi:
|
|
2386
2386
|
return self.get_portfolio_group_with_http_info(scope, code, effective_at, as_at, related_entity_property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
2387
2387
|
|
2388
2388
|
@validate_arguments
|
2389
|
-
def get_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the definition for. Together with the scope
|
2389
|
+
def get_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio group 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 group definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys 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 group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2390
2390
|
"""GetPortfolioGroup: Get portfolio group # noqa: E501
|
2391
2391
|
|
2392
2392
|
Retrieve the definition of a single portfolio group. # noqa: E501
|
@@ -2398,15 +2398,15 @@ class PortfolioGroupsApi:
|
|
2398
2398
|
|
2399
2399
|
:param scope: The scope of the portfolio group to retrieve the definition for. (required)
|
2400
2400
|
:type scope: str
|
2401
|
-
:param code: The code of the portfolio group to retrieve the definition for. Together with the scope
|
2401
|
+
:param code: The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. (required)
|
2402
2402
|
:type code: str
|
2403
2403
|
:param effective_at: The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified.
|
2404
2404
|
:type effective_at: str
|
2405
|
-
:param as_at: The asAt datetime at which to retrieve the portfolio group definition. Defaults to return
|
2405
|
+
:param as_at: The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified.
|
2406
2406
|
:type as_at: datetime
|
2407
|
-
:param related_entity_property_keys: A list of property keys from any domain that supports relationships
|
2407
|
+
:param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
2408
2408
|
:type related_entity_property_keys: List[str]
|
2409
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
2409
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
2410
2410
|
:type relationship_definition_ids: List[str]
|
2411
2411
|
:param async_req: Whether to execute the request asynchronously.
|
2412
2412
|
:type async_req: bool, optional
|
@@ -2545,7 +2545,7 @@ class PortfolioGroupsApi:
|
|
2545
2545
|
def get_portfolio_group_access_metadata_by_key(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Group")], code : Annotated[StrictStr, Field(..., description="The Portfolio Group code")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the access metadata")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the access metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[List[AccessMetadataValue], Awaitable[List[AccessMetadataValue]]]: # noqa: E501
|
2546
2546
|
"""[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group # noqa: E501
|
2547
2547
|
|
2548
|
-
Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts
|
2548
|
+
Get a specific Portfolio Group access metadata 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
|
2549
2549
|
This method makes a synchronous HTTP request by default. To make an
|
2550
2550
|
asynchronous HTTP request, please pass async_req=True
|
2551
2551
|
|
@@ -2584,7 +2584,7 @@ class PortfolioGroupsApi:
|
|
2584
2584
|
def get_portfolio_group_access_metadata_by_key_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Group")], code : Annotated[StrictStr, Field(..., description="The Portfolio Group code")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the access metadata")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the access metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2585
2585
|
"""[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group # noqa: E501
|
2586
2586
|
|
2587
|
-
Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts
|
2587
|
+
Get a specific Portfolio Group access metadata 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
|
2588
2588
|
This method makes a synchronous HTTP request by default. To make an
|
2589
2589
|
asynchronous HTTP request, please pass async_req=True
|
2590
2590
|
|
@@ -2721,15 +2721,15 @@ class PortfolioGroupsApi:
|
|
2721
2721
|
|
2722
2722
|
|
2723
2723
|
@overload
|
2724
|
-
async def get_portfolio_group_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the commands for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.")], 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 result set.
|
2724
|
+
async def get_portfolio_group_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the commands for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.")], 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 result set. For example, to filter on the User ID, use \"userId.id eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ResourceListOfProcessedCommand: # noqa: E501
|
2725
2725
|
...
|
2726
2726
|
|
2727
2727
|
@overload
|
2728
|
-
def get_portfolio_group_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the commands for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.")], 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 result set.
|
2728
|
+
def get_portfolio_group_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the commands for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.")], 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 result set. For example, to filter on the User ID, use \"userId.id eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfProcessedCommand: # noqa: E501
|
2729
2729
|
...
|
2730
2730
|
|
2731
2731
|
@validate_arguments
|
2732
|
-
def get_portfolio_group_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the commands for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.")], 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 result set.
|
2732
|
+
def get_portfolio_group_commands(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the commands for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.")], 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 result set. For example, to filter on the User ID, use \"userId.id eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfProcessedCommand, Awaitable[ResourceListOfProcessedCommand]]: # noqa: E501
|
2733
2733
|
"""GetPortfolioGroupCommands: Get portfolio group commands # noqa: E501
|
2734
2734
|
|
2735
2735
|
Gets all the commands that modified a single portfolio group. # noqa: E501
|
@@ -2747,7 +2747,7 @@ class PortfolioGroupsApi:
|
|
2747
2747
|
:type from_as_at: datetime
|
2748
2748
|
:param to_as_at: The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.
|
2749
2749
|
:type to_as_at: datetime
|
2750
|
-
:param filter: Expression to filter the result set.
|
2750
|
+
:param filter: Expression to filter the result set. For example, to filter on the User ID, use \"userId.id eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2751
2751
|
:type filter: str
|
2752
2752
|
:param async_req: Whether to execute the request asynchronously.
|
2753
2753
|
:type async_req: bool, optional
|
@@ -2768,7 +2768,7 @@ class PortfolioGroupsApi:
|
|
2768
2768
|
return self.get_portfolio_group_commands_with_http_info(scope, code, from_as_at, to_as_at, filter, **kwargs) # noqa: E501
|
2769
2769
|
|
2770
2770
|
@validate_arguments
|
2771
|
-
def get_portfolio_group_commands_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the commands for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.")], 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 result set.
|
2771
|
+
def get_portfolio_group_commands_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to retrieve the commands for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.")], 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 result set. For example, to filter on the User ID, use \"userId.id eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2772
2772
|
"""GetPortfolioGroupCommands: Get portfolio group commands # noqa: E501
|
2773
2773
|
|
2774
2774
|
Gets all the commands that modified a single portfolio group. # noqa: E501
|
@@ -2786,7 +2786,7 @@ class PortfolioGroupsApi:
|
|
2786
2786
|
:type from_as_at: datetime
|
2787
2787
|
:param to_as_at: The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.
|
2788
2788
|
:type to_as_at: datetime
|
2789
|
-
:param filter: Expression to filter the result set.
|
2789
|
+
:param filter: Expression to filter the result set. For example, to filter on the User ID, use \"userId.id eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
2790
2790
|
:type filter: str
|
2791
2791
|
:param async_req: Whether to execute the request asynchronously.
|
2792
2792
|
:type async_req: bool, optional
|
@@ -2911,15 +2911,15 @@ class PortfolioGroupsApi:
|
|
2911
2911
|
|
2912
2912
|
|
2913
2913
|
@overload
|
2914
|
-
async def get_portfolio_group_expansion(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to expand.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio
|
2914
|
+
async def get_portfolio_group_expansion(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to expand.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified.")] = None, property_filter : Annotated[Optional[conlist(StrictStr)], Field(description="The restricted list of property keys from the \"Portfolio\" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. \"Portfolio/Manager/Id\".")] = None, **kwargs) -> ExpandedGroup: # noqa: E501
|
2915
2915
|
...
|
2916
2916
|
|
2917
2917
|
@overload
|
2918
|
-
def get_portfolio_group_expansion(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to expand.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio
|
2918
|
+
def get_portfolio_group_expansion(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to expand.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified.")] = None, property_filter : Annotated[Optional[conlist(StrictStr)], Field(description="The restricted list of property keys from the \"Portfolio\" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. \"Portfolio/Manager/Id\".")] = None, async_req: Optional[bool]=True, **kwargs) -> ExpandedGroup: # noqa: E501
|
2919
2919
|
...
|
2920
2920
|
|
2921
2921
|
@validate_arguments
|
2922
|
-
def get_portfolio_group_expansion(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to expand.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio
|
2922
|
+
def get_portfolio_group_expansion(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to expand.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified.")] = None, property_filter : Annotated[Optional[conlist(StrictStr)], Field(description="The restricted list of property keys from the \"Portfolio\" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. \"Portfolio/Manager/Id\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ExpandedGroup, Awaitable[ExpandedGroup]]: # noqa: E501
|
2923
2923
|
"""[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion # noqa: E501
|
2924
2924
|
|
2925
2925
|
List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified. # noqa: E501
|
@@ -2931,7 +2931,7 @@ class PortfolioGroupsApi:
|
|
2931
2931
|
|
2932
2932
|
:param scope: The scope of the portfolio group to expand. (required)
|
2933
2933
|
:type scope: str
|
2934
|
-
:param code: The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio
|
2934
|
+
:param code: The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. (required)
|
2935
2935
|
:type code: str
|
2936
2936
|
:param effective_at: The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified.
|
2937
2937
|
:type effective_at: str
|
@@ -2958,7 +2958,7 @@ class PortfolioGroupsApi:
|
|
2958
2958
|
return self.get_portfolio_group_expansion_with_http_info(scope, code, effective_at, as_at, property_filter, **kwargs) # noqa: E501
|
2959
2959
|
|
2960
2960
|
@validate_arguments
|
2961
|
-
def get_portfolio_group_expansion_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to expand.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio
|
2961
|
+
def get_portfolio_group_expansion_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to expand.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified.")] = None, property_filter : Annotated[Optional[conlist(StrictStr)], Field(description="The restricted list of property keys from the \"Portfolio\" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. \"Portfolio/Manager/Id\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2962
2962
|
"""[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion # noqa: E501
|
2963
2963
|
|
2964
2964
|
List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified. # noqa: E501
|
@@ -2970,7 +2970,7 @@ class PortfolioGroupsApi:
|
|
2970
2970
|
|
2971
2971
|
:param scope: The scope of the portfolio group to expand. (required)
|
2972
2972
|
:type scope: str
|
2973
|
-
:param code: The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio
|
2973
|
+
:param code: The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. (required)
|
2974
2974
|
:type code: str
|
2975
2975
|
:param effective_at: The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified.
|
2976
2976
|
:type effective_at: str
|
@@ -3278,15 +3278,15 @@ class PortfolioGroupsApi:
|
|
3278
3278
|
|
3279
3279
|
|
3280
3280
|
@overload
|
3281
|
-
async def get_portfolio_group_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group.")], code : Annotated[StrictStr, Field(..., description="The code of the group. Together with the scope this uniquely identifies
|
3281
|
+
async def get_portfolio_group_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group.")], code : Annotated[StrictStr, Field(..., description="The code of the group. Together with the scope this uniquely identifies the portfolio group.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" domain.")], portfolio_group_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the portfolio group. 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 group's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
|
3282
3282
|
...
|
3283
3283
|
|
3284
3284
|
@overload
|
3285
|
-
def get_portfolio_group_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group.")], code : Annotated[StrictStr, Field(..., description="The code of the group. Together with the scope this uniquely identifies
|
3285
|
+
def get_portfolio_group_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group.")], code : Annotated[StrictStr, Field(..., description="The code of the group. Together with the scope this uniquely identifies the portfolio group.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" domain.")], portfolio_group_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the portfolio group. 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 group's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
|
3286
3286
|
...
|
3287
3287
|
|
3288
3288
|
@validate_arguments
|
3289
|
-
def get_portfolio_group_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group.")], code : Annotated[StrictStr, Field(..., description="The code of the group. Together with the scope this uniquely identifies
|
3289
|
+
def get_portfolio_group_property_time_series(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group.")], code : Annotated[StrictStr, Field(..., description="The code of the group. Together with the scope this uniquely identifies the portfolio group.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" domain.")], portfolio_group_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the portfolio group. 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 group's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
|
3290
3290
|
"""[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property # noqa: E501
|
3291
3291
|
|
3292
3292
|
List the complete time series of a portfolio group property. # noqa: E501
|
@@ -3298,9 +3298,9 @@ class PortfolioGroupsApi:
|
|
3298
3298
|
|
3299
3299
|
:param scope: The scope of the group. (required)
|
3300
3300
|
:type scope: str
|
3301
|
-
:param code: The code of the group. Together with the scope this uniquely identifies
|
3301
|
+
:param code: The code of the group. Together with the scope this uniquely identifies the portfolio group. (required)
|
3302
3302
|
:type code: str
|
3303
|
-
:param property_key: The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\".
|
3303
|
+
:param property_key: The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" domain. (required)
|
3304
3304
|
:type property_key: str
|
3305
3305
|
:param portfolio_group_effective_at: The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified.
|
3306
3306
|
:type portfolio_group_effective_at: str
|
@@ -3308,7 +3308,7 @@ class PortfolioGroupsApi:
|
|
3308
3308
|
:type as_at: datetime
|
3309
3309
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
3310
3310
|
:type filter: str
|
3311
|
-
:param page: The pagination token to use to continue listing properties from a previous call to get property time series.
|
3311
|
+
:param page: The pagination token to use to continue listing properties from a previous call to get property time series. 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.
|
3312
3312
|
:type page: str
|
3313
3313
|
:param limit: When paginating, limit the number of returned results to this many.
|
3314
3314
|
:type limit: int
|
@@ -3331,7 +3331,7 @@ class PortfolioGroupsApi:
|
|
3331
3331
|
return self.get_portfolio_group_property_time_series_with_http_info(scope, code, property_key, portfolio_group_effective_at, as_at, filter, page, limit, **kwargs) # noqa: E501
|
3332
3332
|
|
3333
3333
|
@validate_arguments
|
3334
|
-
def get_portfolio_group_property_time_series_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group.")], code : Annotated[StrictStr, Field(..., description="The code of the group. Together with the scope this uniquely identifies
|
3334
|
+
def get_portfolio_group_property_time_series_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group.")], code : Annotated[StrictStr, Field(..., description="The code of the group. Together with the scope this uniquely identifies the portfolio group.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" domain.")], portfolio_group_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the portfolio group. 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 group's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3335
3335
|
"""[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property # noqa: E501
|
3336
3336
|
|
3337
3337
|
List the complete time series of a portfolio group property. # noqa: E501
|
@@ -3343,9 +3343,9 @@ class PortfolioGroupsApi:
|
|
3343
3343
|
|
3344
3344
|
:param scope: The scope of the group. (required)
|
3345
3345
|
:type scope: str
|
3346
|
-
:param code: The code of the group. Together with the scope this uniquely identifies
|
3346
|
+
:param code: The code of the group. Together with the scope this uniquely identifies the portfolio group. (required)
|
3347
3347
|
:type code: str
|
3348
|
-
:param property_key: The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\".
|
3348
|
+
:param property_key: The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\". Each property must be from the \"PortfolioGroup\" domain. (required)
|
3349
3349
|
:type property_key: str
|
3350
3350
|
:param portfolio_group_effective_at: The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified.
|
3351
3351
|
:type portfolio_group_effective_at: str
|
@@ -3353,7 +3353,7 @@ class PortfolioGroupsApi:
|
|
3353
3353
|
:type as_at: datetime
|
3354
3354
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
3355
3355
|
:type filter: str
|
3356
|
-
:param page: The pagination token to use to continue listing properties from a previous call to get property time series.
|
3356
|
+
:param page: The pagination token to use to continue listing properties from a previous call to get property time series. 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.
|
3357
3357
|
:type page: str
|
3358
3358
|
:param limit: When paginating, limit the number of returned results to this many.
|
3359
3359
|
:type limit: int
|
@@ -3489,15 +3489,15 @@ class PortfolioGroupsApi:
|
|
3489
3489
|
|
3490
3490
|
|
3491
3491
|
@overload
|
3492
|
-
async def get_portfolio_group_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3492
|
+
async def get_portfolio_group_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], 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 return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ResourceListOfRelation: # noqa: E501
|
3493
3493
|
...
|
3494
3494
|
|
3495
3495
|
@overload
|
3496
|
-
def get_portfolio_group_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3496
|
+
def get_portfolio_group_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], 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 return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated 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
|
3497
3497
|
...
|
3498
3498
|
|
3499
3499
|
@validate_arguments
|
3500
|
-
def get_portfolio_group_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3500
|
+
def get_portfolio_group_relations(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], 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 return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated 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
|
3501
3501
|
"""[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group # noqa: E501
|
3502
3502
|
|
3503
3503
|
Get relations for the specified Portfolio Group # noqa: E501
|
@@ -3509,7 +3509,7 @@ class PortfolioGroupsApi:
|
|
3509
3509
|
|
3510
3510
|
:param scope: The scope of the portfolio group. (required)
|
3511
3511
|
:type scope: str
|
3512
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
3512
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
3513
3513
|
:type code: str
|
3514
3514
|
:param effective_at: The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.
|
3515
3515
|
:type effective_at: str
|
@@ -3517,7 +3517,7 @@ class PortfolioGroupsApi:
|
|
3517
3517
|
:type as_at: datetime
|
3518
3518
|
:param filter: Expression to filter the relations. Users should provide null or empty string for this field until further notice.
|
3519
3519
|
:type filter: str
|
3520
|
-
:param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format
|
3520
|
+
:param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array.
|
3521
3521
|
:type identifier_types: List[str]
|
3522
3522
|
:param async_req: Whether to execute the request asynchronously.
|
3523
3523
|
:type async_req: bool, optional
|
@@ -3538,7 +3538,7 @@ class PortfolioGroupsApi:
|
|
3538
3538
|
return self.get_portfolio_group_relations_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
|
3539
3539
|
|
3540
3540
|
@validate_arguments
|
3541
|
-
def get_portfolio_group_relations_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3541
|
+
def get_portfolio_group_relations_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], 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 return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
3542
3542
|
"""[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group # noqa: E501
|
3543
3543
|
|
3544
3544
|
Get relations for the specified Portfolio Group # noqa: E501
|
@@ -3550,7 +3550,7 @@ class PortfolioGroupsApi:
|
|
3550
3550
|
|
3551
3551
|
:param scope: The scope of the portfolio group. (required)
|
3552
3552
|
:type scope: str
|
3553
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
3553
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
3554
3554
|
:type code: str
|
3555
3555
|
:param effective_at: The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.
|
3556
3556
|
:type effective_at: str
|
@@ -3558,7 +3558,7 @@ class PortfolioGroupsApi:
|
|
3558
3558
|
:type as_at: datetime
|
3559
3559
|
:param filter: Expression to filter the relations. Users should provide null or empty string for this field until further notice.
|
3560
3560
|
:type filter: str
|
3561
|
-
:param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format
|
3561
|
+
:param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array.
|
3562
3562
|
:type identifier_types: List[str]
|
3563
3563
|
:param async_req: Whether to execute the request asynchronously.
|
3564
3564
|
:type async_req: bool, optional
|
@@ -3685,15 +3685,15 @@ class PortfolioGroupsApi:
|
|
3685
3685
|
|
3686
3686
|
|
3687
3687
|
@overload
|
3688
|
-
async def get_portfolio_group_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3688
|
+
async def get_portfolio_group_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationship. 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 return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide 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
|
3689
3689
|
...
|
3690
3690
|
|
3691
3691
|
@overload
|
3692
|
-
def get_portfolio_group_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3692
|
+
def get_portfolio_group_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationship. 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 return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide 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
|
3693
3693
|
...
|
3694
3694
|
|
3695
3695
|
@validate_arguments
|
3696
|
-
def get_portfolio_group_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3696
|
+
def get_portfolio_group_relationships(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationship. 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 return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide 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
|
3697
3697
|
"""[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group # noqa: E501
|
3698
3698
|
|
3699
3699
|
Get relationships for the specified Portfolio Group # noqa: E501
|
@@ -3705,7 +3705,7 @@ class PortfolioGroupsApi:
|
|
3705
3705
|
|
3706
3706
|
:param scope: The scope of the portfolio group. (required)
|
3707
3707
|
:type scope: str
|
3708
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
3708
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
3709
3709
|
:type code: str
|
3710
3710
|
:param effective_at: The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified.
|
3711
3711
|
:type effective_at: str
|
@@ -3713,7 +3713,7 @@ class PortfolioGroupsApi:
|
|
3713
3713
|
:type as_at: datetime
|
3714
3714
|
:param filter: Expression to filter relationships. Users should provide null or empty string for this field until further notice.
|
3715
3715
|
:type filter: str
|
3716
|
-
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3716
|
+
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
|
3717
3717
|
:type identifier_types: List[str]
|
3718
3718
|
:param async_req: Whether to execute the request asynchronously.
|
3719
3719
|
:type async_req: bool, optional
|
@@ -3734,7 +3734,7 @@ class PortfolioGroupsApi:
|
|
3734
3734
|
return self.get_portfolio_group_relationships_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
|
3735
3735
|
|
3736
3736
|
@validate_arguments
|
3737
|
-
def get_portfolio_group_relationships_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3737
|
+
def get_portfolio_group_relationships_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve relationship. 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 return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide 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
|
3738
3738
|
"""[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group # noqa: E501
|
3739
3739
|
|
3740
3740
|
Get relationships for the specified Portfolio Group # noqa: E501
|
@@ -3746,7 +3746,7 @@ class PortfolioGroupsApi:
|
|
3746
3746
|
|
3747
3747
|
:param scope: The scope of the portfolio group. (required)
|
3748
3748
|
:type scope: str
|
3749
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
3749
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
3750
3750
|
:type code: str
|
3751
3751
|
:param effective_at: The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified.
|
3752
3752
|
:type effective_at: str
|
@@ -3754,7 +3754,7 @@ class PortfolioGroupsApi:
|
|
3754
3754
|
:type as_at: datetime
|
3755
3755
|
:param filter: Expression to filter relationships. Users should provide null or empty string for this field until further notice.
|
3756
3756
|
:type filter: str
|
3757
|
-
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities.
|
3757
|
+
:param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
|
3758
3758
|
:type identifier_types: List[str]
|
3759
3759
|
:param async_req: Whether to execute the request asynchronously.
|
3760
3760
|
:type async_req: bool, optional
|
@@ -3881,18 +3881,18 @@ class PortfolioGroupsApi:
|
|
3881
3881
|
|
3882
3882
|
|
3883
3883
|
@overload
|
3884
|
-
async def get_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3884
|
+
async def get_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Transaction\", \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.")] = 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, **kwargs) -> VersionedResourceListOfTransaction: # noqa: E501
|
3885
3885
|
...
|
3886
3886
|
|
3887
3887
|
@overload
|
3888
|
-
def get_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3888
|
+
def get_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Transaction\", \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.")] = 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, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfTransaction: # noqa: E501
|
3889
3889
|
...
|
3890
3890
|
|
3891
3891
|
@validate_arguments
|
3892
|
-
def get_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3892
|
+
def get_transactions_for_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Transaction\", \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.")] = 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, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfTransaction, Awaitable[VersionedResourceListOfTransaction]]: # noqa: E501
|
3893
3893
|
"""GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group # noqa: E501
|
3894
3894
|
|
3895
|
-
Get transactions for transaction portfolios in a portfolio group over a given interval of effective time.
|
3895
|
+
Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. # noqa: E501
|
3896
3896
|
This method makes a synchronous HTTP request by default. To make an
|
3897
3897
|
asynchronous HTTP request, please pass async_req=True
|
3898
3898
|
|
@@ -3901,23 +3901,23 @@ class PortfolioGroupsApi:
|
|
3901
3901
|
|
3902
3902
|
:param scope: The scope of the portfolio group. (required)
|
3903
3903
|
:type scope: str
|
3904
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
3904
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
3905
3905
|
:type code: str
|
3906
|
-
:param from_transaction_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions.
|
3906
|
+
:param from_transaction_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified.
|
3907
3907
|
:type from_transaction_date: str
|
3908
|
-
:param to_transaction_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.
|
3908
|
+
:param to_transaction_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.
|
3909
3909
|
:type to_transaction_date: str
|
3910
|
-
:param as_at: The asAt datetime at which to retrieve the transactions. Defaults to return the latest version
|
3910
|
+
:param as_at: The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified.
|
3911
3911
|
:type as_at: datetime
|
3912
|
-
:param filter: Expression to filter the result set.
|
3912
|
+
:param filter: Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
3913
3913
|
:type filter: str
|
3914
|
-
:param property_keys: A list of property keys from the \"Instrument\", \"Transaction\", \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto
|
3914
|
+
:param property_keys: A list of property keys from the \"Instrument\", \"Transaction\", \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
3915
3915
|
:type property_keys: List[str]
|
3916
3916
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
3917
3917
|
:type limit: int
|
3918
3918
|
:param page: The pagination token to use to continue listing transactions from a previous call to GetTransactions.
|
3919
3919
|
:type page: str
|
3920
|
-
:param show_cancelled_transactions: Option to specify whether or not to include cancelled transactions,
|
3920
|
+
:param show_cancelled_transactions: Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.
|
3921
3921
|
:type show_cancelled_transactions: bool
|
3922
3922
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3923
3923
|
:type sort_by: List[str]
|
@@ -3940,10 +3940,10 @@ class PortfolioGroupsApi:
|
|
3940
3940
|
return self.get_transactions_for_portfolio_group_with_http_info(scope, code, from_transaction_date, to_transaction_date, as_at, filter, property_keys, limit, page, show_cancelled_transactions, sort_by, **kwargs) # noqa: E501
|
3941
3941
|
|
3942
3942
|
@validate_arguments
|
3943
|
-
def get_transactions_for_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies
|
3943
|
+
def get_transactions_for_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Instrument\", \"Transaction\", \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.")] = 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, **kwargs) -> ApiResponse: # noqa: E501
|
3944
3944
|
"""GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group # noqa: E501
|
3945
3945
|
|
3946
|
-
Get transactions for transaction portfolios in a portfolio group over a given interval of effective time.
|
3946
|
+
Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. # noqa: E501
|
3947
3947
|
This method makes a synchronous HTTP request by default. To make an
|
3948
3948
|
asynchronous HTTP request, please pass async_req=True
|
3949
3949
|
|
@@ -3952,23 +3952,23 @@ class PortfolioGroupsApi:
|
|
3952
3952
|
|
3953
3953
|
:param scope: The scope of the portfolio group. (required)
|
3954
3954
|
:type scope: str
|
3955
|
-
:param code: The code of the portfolio group. Together with the scope this uniquely identifies
|
3955
|
+
:param code: The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)
|
3956
3956
|
:type code: str
|
3957
|
-
:param from_transaction_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions.
|
3957
|
+
:param from_transaction_date: The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified.
|
3958
3958
|
:type from_transaction_date: str
|
3959
|
-
:param to_transaction_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.
|
3959
|
+
:param to_transaction_date: The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.
|
3960
3960
|
:type to_transaction_date: str
|
3961
|
-
:param as_at: The asAt datetime at which to retrieve the transactions. Defaults to return the latest version
|
3961
|
+
:param as_at: The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified.
|
3962
3962
|
:type as_at: datetime
|
3963
|
-
:param filter: Expression to filter the result set.
|
3963
|
+
:param filter: Expression to filter the result set. For example, to filter on the Transaction Type, use \"type eq 'Buy'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
3964
3964
|
:type filter: str
|
3965
|
-
:param property_keys: A list of property keys from the \"Instrument\", \"Transaction\", \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto
|
3965
|
+
:param property_keys: A list of property keys from the \"Instrument\", \"Transaction\", \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. \"Instrument/system/Name\" or \"Transaction/strategy/quantsignal\".
|
3966
3966
|
:type property_keys: List[str]
|
3967
3967
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
3968
3968
|
:type limit: int
|
3969
3969
|
:param page: The pagination token to use to continue listing transactions from a previous call to GetTransactions.
|
3970
3970
|
:type page: str
|
3971
|
-
:param show_cancelled_transactions: Option to specify whether or not to include cancelled transactions,
|
3971
|
+
:param show_cancelled_transactions: Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified.
|
3972
3972
|
:type show_cancelled_transactions: bool
|
3973
3973
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
3974
3974
|
:type sort_by: List[str]
|
@@ -4118,15 +4118,15 @@ class PortfolioGroupsApi:
|
|
4118
4118
|
|
4119
4119
|
|
4120
4120
|
@overload
|
4121
|
-
async def list_portfolio_groups(self, scope : Annotated[StrictStr, Field(..., description="The scope to list the portfolio groups in.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio groups. 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 groups. Defaults to return the latest version of each portfolio group if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This
|
4121
|
+
async def list_portfolio_groups(self, scope : Annotated[StrictStr, Field(..., description="The scope to list the portfolio groups in.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio groups. 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 groups. Defaults to return the latest version of each portfolio group if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys 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 groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> PagedResourceListOfPortfolioGroup: # noqa: E501
|
4122
4122
|
...
|
4123
4123
|
|
4124
4124
|
@overload
|
4125
|
-
def list_portfolio_groups(self, scope : Annotated[StrictStr, Field(..., description="The scope to list the portfolio groups in.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio groups. 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 groups. Defaults to return the latest version of each portfolio group if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This
|
4125
|
+
def list_portfolio_groups(self, scope : Annotated[StrictStr, Field(..., description="The scope to list the portfolio groups in.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio groups. 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 groups. Defaults to return the latest version of each portfolio group if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys 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 groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPortfolioGroup: # noqa: E501
|
4126
4126
|
...
|
4127
4127
|
|
4128
4128
|
@validate_arguments
|
4129
|
-
def list_portfolio_groups(self, scope : Annotated[StrictStr, Field(..., description="The scope to list the portfolio groups in.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio groups. 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 groups. Defaults to return the latest version of each portfolio group if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This
|
4129
|
+
def list_portfolio_groups(self, scope : Annotated[StrictStr, Field(..., description="The scope to list the portfolio groups in.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio groups. 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 groups. Defaults to return the latest version of each portfolio group if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys 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 groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPortfolioGroup, Awaitable[PagedResourceListOfPortfolioGroup]]: # noqa: E501
|
4130
4130
|
"""ListPortfolioGroups: List portfolio groups # noqa: E501
|
4131
4131
|
|
4132
4132
|
List all the portfolio groups in a single scope. # noqa: E501
|
@@ -4142,17 +4142,17 @@ class PortfolioGroupsApi:
|
|
4142
4142
|
:type effective_at: str
|
4143
4143
|
:param as_at: The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified.
|
4144
4144
|
:type as_at: datetime
|
4145
|
-
:param page: The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This
|
4145
|
+
:param page: The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.
|
4146
4146
|
:type page: str
|
4147
4147
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.
|
4148
4148
|
:type limit: int
|
4149
|
-
:param filter: Expression to filter the result set.
|
4149
|
+
:param filter: Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
4150
4150
|
:type filter: str
|
4151
4151
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
4152
4152
|
:type sort_by: List[str]
|
4153
|
-
:param related_entity_property_keys: A list of property keys from any domain that supports relationships
|
4153
|
+
:param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
4154
4154
|
:type related_entity_property_keys: List[str]
|
4155
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
4155
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
4156
4156
|
:type relationship_definition_ids: List[str]
|
4157
4157
|
:param async_req: Whether to execute the request asynchronously.
|
4158
4158
|
:type async_req: bool, optional
|
@@ -4173,7 +4173,7 @@ class PortfolioGroupsApi:
|
|
4173
4173
|
return self.list_portfolio_groups_with_http_info(scope, effective_at, as_at, page, limit, filter, sort_by, related_entity_property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
4174
4174
|
|
4175
4175
|
@validate_arguments
|
4176
|
-
def list_portfolio_groups_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to list the portfolio groups in.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio groups. 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 groups. Defaults to return the latest version of each portfolio group if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This
|
4176
|
+
def list_portfolio_groups_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to list the portfolio groups in.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the portfolio groups. 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 groups. Defaults to return the latest version of each portfolio group if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys 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 groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4177
4177
|
"""ListPortfolioGroups: List portfolio groups # noqa: E501
|
4178
4178
|
|
4179
4179
|
List all the portfolio groups in a single scope. # noqa: E501
|
@@ -4189,17 +4189,17 @@ class PortfolioGroupsApi:
|
|
4189
4189
|
:type effective_at: str
|
4190
4190
|
:param as_at: The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified.
|
4191
4191
|
:type as_at: datetime
|
4192
|
-
:param page: The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This
|
4192
|
+
:param page: The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.
|
4193
4193
|
:type page: str
|
4194
4194
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.
|
4195
4195
|
:type limit: int
|
4196
|
-
:param filter: Expression to filter the result set.
|
4196
|
+
:param filter: Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
4197
4197
|
:type filter: str
|
4198
4198
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
4199
4199
|
:type sort_by: List[str]
|
4200
|
-
:param related_entity_property_keys: A list of property keys from any domain that supports relationships
|
4200
|
+
:param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
|
4201
4201
|
:type related_entity_property_keys: List[str]
|
4202
|
-
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities
|
4202
|
+
:param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
|
4203
4203
|
:type relationship_definition_ids: List[str]
|
4204
4204
|
:param async_req: Whether to execute the request asynchronously.
|
4205
4205
|
:type async_req: bool, optional
|
@@ -4351,7 +4351,7 @@ class PortfolioGroupsApi:
|
|
4351
4351
|
def patch_portfolio_group_access_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Group")], code : Annotated[StrictStr, Field(..., description="The Portfolio Group 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 be 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
|
4352
4352
|
"""[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. # noqa: E501
|
4353
4353
|
|
4354
|
-
Patch Portfolio Group Access Metadata Rules in a single scope.
|
4354
|
+
Patch Portfolio Group 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 Group 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
|
4355
4355
|
This method makes a synchronous HTTP request by default. To make an
|
4356
4356
|
asynchronous HTTP request, please pass async_req=True
|
4357
4357
|
|
@@ -4390,7 +4390,7 @@ class PortfolioGroupsApi:
|
|
4390
4390
|
def patch_portfolio_group_access_metadata_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Group")], code : Annotated[StrictStr, Field(..., description="The Portfolio Group 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 be 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
|
4391
4391
|
"""[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. # noqa: E501
|
4392
4392
|
|
4393
|
-
Patch Portfolio Group Access Metadata Rules in a single scope.
|
4393
|
+
Patch Portfolio Group 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 Group 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
|
4394
4394
|
This method makes a synchronous HTTP request by default. To make an
|
4395
4395
|
asynchronous HTTP request, please pass async_req=True
|
4396
4396
|
|
@@ -4545,7 +4545,7 @@ class PortfolioGroupsApi:
|
|
4545
4545
|
def update_portfolio_group(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to update the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition.")] = None, update_portfolio_group_request : Annotated[Optional[UpdatePortfolioGroupRequest], Field(description="The updated portfolio group definition.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioGroup, Awaitable[PortfolioGroup]]: # noqa: E501
|
4546
4546
|
"""[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group # noqa: E501
|
4547
4547
|
|
4548
|
-
Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable
|
4548
|
+
Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group. # noqa: E501
|
4549
4549
|
This method makes a synchronous HTTP request by default. To make an
|
4550
4550
|
asynchronous HTTP request, please pass async_req=True
|
4551
4551
|
|
@@ -4582,7 +4582,7 @@ class PortfolioGroupsApi:
|
|
4582
4582
|
def update_portfolio_group_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the portfolio group to update the definition for.")], code : Annotated[StrictStr, Field(..., description="The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to update the definition.")] = None, update_portfolio_group_request : Annotated[Optional[UpdatePortfolioGroupRequest], Field(description="The updated portfolio group definition.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4583
4583
|
"""[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group # noqa: E501
|
4584
4584
|
|
4585
|
-
Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable
|
4585
|
+
Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group. # noqa: E501
|
4586
4586
|
This method makes a synchronous HTTP request by default. To make an
|
4587
4587
|
asynchronous HTTP request, please pass async_req=True
|
4588
4588
|
|
@@ -4717,18 +4717,18 @@ class PortfolioGroupsApi:
|
|
4717
4717
|
|
4718
4718
|
|
4719
4719
|
@overload
|
4720
|
-
async def upsert_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the group. Each property in
|
4720
|
+
async def upsert_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\".")] = None, **kwargs) -> PortfolioGroupProperties: # noqa: E501
|
4721
4721
|
...
|
4722
4722
|
|
4723
4723
|
@overload
|
4724
|
-
def upsert_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the group. Each property in
|
4724
|
+
def upsert_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PortfolioGroupProperties: # noqa: E501
|
4725
4725
|
...
|
4726
4726
|
|
4727
4727
|
@validate_arguments
|
4728
|
-
def upsert_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the group. Each property in
|
4728
|
+
def upsert_group_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioGroupProperties, Awaitable[PortfolioGroupProperties]]: # noqa: E501
|
4729
4729
|
"""[EARLY ACCESS] UpsertGroupProperties: Upsert group properties # noqa: E501
|
4730
4730
|
|
4731
|
-
Update or insert one or more properties onto a single group. A property will be updated if it
|
4731
|
+
Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property 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
|
4732
4732
|
This method makes a synchronous HTTP request by default. To make an
|
4733
4733
|
asynchronous HTTP request, please pass async_req=True
|
4734
4734
|
|
@@ -4739,7 +4739,7 @@ class PortfolioGroupsApi:
|
|
4739
4739
|
:type scope: str
|
4740
4740
|
:param code: The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. (required)
|
4741
4741
|
:type code: str
|
4742
|
-
:param request_body: The properties to be updated or inserted onto the group. Each property in
|
4742
|
+
:param request_body: The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\".
|
4743
4743
|
:type request_body: Dict[str, ModelProperty]
|
4744
4744
|
:param async_req: Whether to execute the request asynchronously.
|
4745
4745
|
:type async_req: bool, optional
|
@@ -4760,10 +4760,10 @@ class PortfolioGroupsApi:
|
|
4760
4760
|
return self.upsert_group_properties_with_http_info(scope, code, request_body, **kwargs) # noqa: E501
|
4761
4761
|
|
4762
4762
|
@validate_arguments
|
4763
|
-
def upsert_group_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the group. Each property in
|
4763
|
+
def upsert_group_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the group to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
4764
4764
|
"""[EARLY ACCESS] UpsertGroupProperties: Upsert group properties # noqa: E501
|
4765
4765
|
|
4766
|
-
Update or insert one or more properties onto a single group. A property will be updated if it
|
4766
|
+
Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property 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
|
4767
4767
|
This method makes a synchronous HTTP request by default. To make an
|
4768
4768
|
asynchronous HTTP request, please pass async_req=True
|
4769
4769
|
|
@@ -4774,7 +4774,7 @@ class PortfolioGroupsApi:
|
|
4774
4774
|
:type scope: str
|
4775
4775
|
:param code: The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. (required)
|
4776
4776
|
:type code: str
|
4777
|
-
:param request_body: The properties to be updated or inserted onto the group. Each property in
|
4777
|
+
:param request_body: The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"PortfolioGroup/Manager/Id\".
|
4778
4778
|
:type request_body: Dict[str, ModelProperty]
|
4779
4779
|
:param async_req: Whether to execute the request asynchronously.
|
4780
4780
|
:type async_req: bool, optional
|
@@ -4903,7 +4903,7 @@ class PortfolioGroupsApi:
|
|
4903
4903
|
def upsert_portfolio_group_access_metadata(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Group")], code : Annotated[StrictStr, Field(..., description="The Portfolio Group code")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the access metadata entry to upsert")], upsert_portfolio_group_access_metadata_request : Annotated[UpsertPortfolioGroupAccessMetadataRequest, Field(..., description="The Portfolio Group Access Metadata rule to upsert")], effective_at : Annotated[Optional[StrictStr], Field( description="The date this rule will be 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
|
4904
4904
|
"""UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
4905
4905
|
|
4906
|
-
Update or insert one Portfolio Group Access Metadata Entry in a single scope. An item will be updated if it already exists
|
4906
|
+
Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
4907
4907
|
This method makes a synchronous HTTP request by default. To make an
|
4908
4908
|
asynchronous HTTP request, please pass async_req=True
|
4909
4909
|
|
@@ -4944,7 +4944,7 @@ class PortfolioGroupsApi:
|
|
4944
4944
|
def upsert_portfolio_group_access_metadata_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Portfolio Group")], code : Annotated[StrictStr, Field(..., description="The Portfolio Group code")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the access metadata entry to upsert")], upsert_portfolio_group_access_metadata_request : Annotated[UpsertPortfolioGroupAccessMetadataRequest, Field(..., description="The Portfolio Group Access Metadata rule to upsert")], effective_at : Annotated[Optional[StrictStr], Field( description="The date this rule will be 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
|
4945
4945
|
"""UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
4946
4946
|
|
4947
|
-
Update or insert one Portfolio Group Access Metadata Entry in a single scope. An item will be updated if it already exists
|
4947
|
+
Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
4948
4948
|
This method makes a synchronous HTTP request by default. To make an
|
4949
4949
|
asynchronous HTTP request, please pass async_req=True
|
4950
4950
|
|