lusid-sdk 2.1.911__py3-none-any.whl → 2.1.912__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +126 -126
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_holding.py +6 -2
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +6 -4
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/settlement_schedule.py +20 -2
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.912.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.912.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.912.dist-info}/WHEEL +0 -0
lusid/api/orders_api.py
CHANGED
@@ -70,7 +70,7 @@ class OrdersApi:
|
|
70
70
|
def delete_order(self, scope : Annotated[StrictStr, Field(..., description="The order scope.")], code : Annotated[StrictStr, Field(..., description="The order's code. This, together with the scope uniquely identifies the order to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
71
71
|
"""[EARLY ACCESS] DeleteOrder: Delete order # noqa: E501
|
72
72
|
|
73
|
-
Delete an order. Deletion will be valid from the order's creation datetime.
|
73
|
+
Delete an order. Deletion will be valid from the order's creation datetime. This means that the order will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
74
74
|
This method makes a synchronous HTTP request by default. To make an
|
75
75
|
asynchronous HTTP request, please pass async_req=True
|
76
76
|
|
@@ -103,7 +103,7 @@ class OrdersApi:
|
|
103
103
|
def delete_order_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The order scope.")], code : Annotated[StrictStr, Field(..., description="The order's code. This, together with the scope uniquely identifies the order to delete.")], **kwargs) -> ApiResponse: # noqa: E501
|
104
104
|
"""[EARLY ACCESS] DeleteOrder: Delete order # noqa: E501
|
105
105
|
|
106
|
-
Delete an order. Deletion will be valid from the order's creation datetime.
|
106
|
+
Delete an order. Deletion will be valid from the order's creation datetime. This means that the order will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
107
107
|
This method makes a synchronous HTTP request by default. To make an
|
108
108
|
asynchronous HTTP request, please pass async_req=True
|
109
109
|
|
@@ -219,15 +219,15 @@ class OrdersApi:
|
|
219
219
|
|
220
220
|
|
221
221
|
@overload
|
222
|
-
async def get_order(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the order belongs.")], code : Annotated[StrictStr, Field(..., description="The order's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Orders\" domain to decorate onto the order.
|
222
|
+
async def get_order(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the order belongs.")], code : Annotated[StrictStr, Field(..., description="The order's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Orders\" domain to decorate onto the order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\".")] = None, **kwargs) -> Order: # noqa: E501
|
223
223
|
...
|
224
224
|
|
225
225
|
@overload
|
226
|
-
def get_order(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the order belongs.")], code : Annotated[StrictStr, Field(..., description="The order's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Orders\" domain to decorate onto the order.
|
226
|
+
def get_order(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the order belongs.")], code : Annotated[StrictStr, Field(..., description="The order's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Orders\" domain to decorate onto the order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> Order: # noqa: E501
|
227
227
|
...
|
228
228
|
|
229
229
|
@validate_arguments
|
230
|
-
def get_order(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the order belongs.")], code : Annotated[StrictStr, Field(..., description="The order's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Orders\" domain to decorate onto the order.
|
230
|
+
def get_order(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the order belongs.")], code : Annotated[StrictStr, Field(..., description="The order's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Orders\" domain to decorate onto the order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Order, Awaitable[Order]]: # noqa: E501
|
231
231
|
"""[EARLY ACCESS] GetOrder: Get Order # noqa: E501
|
232
232
|
|
233
233
|
Fetch an Order that matches the specified identifier. # noqa: E501
|
@@ -243,7 +243,7 @@ class OrdersApi:
|
|
243
243
|
:type code: str
|
244
244
|
:param as_at: The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
|
245
245
|
:type as_at: datetime
|
246
|
-
:param property_keys: A list of property keys from the \"Orders\" domain to decorate onto the order.
|
246
|
+
:param property_keys: A list of property keys from the \"Orders\" domain to decorate onto the order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\".
|
247
247
|
:type property_keys: List[str]
|
248
248
|
:param async_req: Whether to execute the request asynchronously.
|
249
249
|
:type async_req: bool, optional
|
@@ -264,7 +264,7 @@ class OrdersApi:
|
|
264
264
|
return self.get_order_with_http_info(scope, code, as_at, property_keys, **kwargs) # noqa: E501
|
265
265
|
|
266
266
|
@validate_arguments
|
267
|
-
def get_order_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the order belongs.")], code : Annotated[StrictStr, Field(..., description="The order's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Orders\" domain to decorate onto the order.
|
267
|
+
def get_order_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the order belongs.")], code : Annotated[StrictStr, Field(..., description="The order's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Orders\" domain to decorate onto the order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
268
268
|
"""[EARLY ACCESS] GetOrder: Get Order # noqa: E501
|
269
269
|
|
270
270
|
Fetch an Order that matches the specified identifier. # noqa: E501
|
@@ -280,7 +280,7 @@ class OrdersApi:
|
|
280
280
|
:type code: str
|
281
281
|
:param as_at: The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
|
282
282
|
:type as_at: datetime
|
283
|
-
:param property_keys: A list of property keys from the \"Orders\" domain to decorate onto the order.
|
283
|
+
:param property_keys: A list of property keys from the \"Orders\" domain to decorate onto the order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\".
|
284
284
|
:type property_keys: List[str]
|
285
285
|
:param async_req: Whether to execute the request asynchronously.
|
286
286
|
:type async_req: bool, optional
|
@@ -399,15 +399,15 @@ class OrdersApi:
|
|
399
399
|
|
400
400
|
|
401
401
|
@overload
|
402
|
-
async def list_orders(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orders from a previous call to list orders.
|
402
|
+
async def list_orders(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orders from a previous call to list orders. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Orders\" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.")] = None, **kwargs) -> PagedResourceListOfOrder: # noqa: E501
|
403
403
|
...
|
404
404
|
|
405
405
|
@overload
|
406
|
-
def list_orders(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orders from a previous call to list orders.
|
406
|
+
def list_orders(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orders from a previous call to list orders. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Orders\" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfOrder: # noqa: E501
|
407
407
|
...
|
408
408
|
|
409
409
|
@validate_arguments
|
410
|
-
def list_orders(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orders from a previous call to list orders.
|
410
|
+
def list_orders(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orders from a previous call to list orders. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Orders\" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfOrder, Awaitable[PagedResourceListOfOrder]]: # noqa: E501
|
411
411
|
"""ListOrders: List Orders # noqa: E501
|
412
412
|
|
413
413
|
Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). # noqa: E501
|
@@ -419,15 +419,15 @@ class OrdersApi:
|
|
419
419
|
|
420
420
|
:param as_at: The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
|
421
421
|
:type as_at: datetime
|
422
|
-
:param page: The pagination token to use to continue listing orders from a previous call to list orders.
|
422
|
+
:param page: The pagination token to use to continue listing orders from a previous call to list orders. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
423
423
|
:type page: str
|
424
424
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
425
425
|
:type sort_by: List[str]
|
426
426
|
:param limit: When paginating, limit the number of returned results to this many.
|
427
427
|
:type limit: int
|
428
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
428
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
429
429
|
:type filter: str
|
430
|
-
:param property_keys: A list of property keys from the \"Orders\" domain to decorate onto each order.
|
430
|
+
:param property_keys: A list of property keys from the \"Orders\" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
431
431
|
:type property_keys: List[str]
|
432
432
|
:param data_model_scope: The optional scope of a Custom Data Model to use
|
433
433
|
:type data_model_scope: str
|
@@ -454,7 +454,7 @@ class OrdersApi:
|
|
454
454
|
return self.list_orders_with_http_info(as_at, page, sort_by, limit, filter, property_keys, data_model_scope, data_model_code, membership_type, **kwargs) # noqa: E501
|
455
455
|
|
456
456
|
@validate_arguments
|
457
|
-
def list_orders_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orders from a previous call to list orders.
|
457
|
+
def list_orders_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orders from a previous call to list orders. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Orders\" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, membership_type : Annotated[Optional[StrictStr], Field( description="The membership types of the specified Custom Data Model to return. Allowable values are Member, Candidate and All. Defaults to Member.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
458
458
|
"""ListOrders: List Orders # noqa: E501
|
459
459
|
|
460
460
|
Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). # noqa: E501
|
@@ -466,15 +466,15 @@ class OrdersApi:
|
|
466
466
|
|
467
467
|
:param as_at: The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
|
468
468
|
:type as_at: datetime
|
469
|
-
:param page: The pagination token to use to continue listing orders from a previous call to list orders.
|
469
|
+
:param page: The pagination token to use to continue listing orders from a previous call to list orders. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
470
470
|
:type page: str
|
471
471
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
472
472
|
:type sort_by: List[str]
|
473
473
|
:param limit: When paginating, limit the number of returned results to this many.
|
474
474
|
:type limit: int
|
475
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
475
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
476
476
|
:type filter: str
|
477
|
-
:param property_keys: A list of property keys from the \"Orders\" domain to decorate onto each order.
|
477
|
+
:param property_keys: A list of property keys from the \"Orders\" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
478
478
|
:type property_keys: List[str]
|
479
479
|
:param data_model_scope: The optional scope of a Custom Data Model to use
|
480
480
|
:type data_model_scope: str
|
lusid/api/packages_api.py
CHANGED
@@ -70,7 +70,7 @@ class PackagesApi:
|
|
70
70
|
def delete_package(self, scope : Annotated[StrictStr, Field(..., description="The package scope.")], code : Annotated[StrictStr, Field(..., description="The package's code. This, together with the scope uniquely identifies the package to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
71
71
|
"""[EXPERIMENTAL] DeletePackage: Delete package # noqa: E501
|
72
72
|
|
73
|
-
Delete an package. Deletion will be valid from the package's creation datetime.
|
73
|
+
Delete an package. Deletion will be valid from the package's creation datetime. This means that the package will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
74
74
|
This method makes a synchronous HTTP request by default. To make an
|
75
75
|
asynchronous HTTP request, please pass async_req=True
|
76
76
|
|
@@ -103,7 +103,7 @@ class PackagesApi:
|
|
103
103
|
def delete_package_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The package scope.")], code : Annotated[StrictStr, Field(..., description="The package's code. This, together with the scope uniquely identifies the package to delete.")], **kwargs) -> ApiResponse: # noqa: E501
|
104
104
|
"""[EXPERIMENTAL] DeletePackage: Delete package # noqa: E501
|
105
105
|
|
106
|
-
Delete an package. Deletion will be valid from the package's creation datetime.
|
106
|
+
Delete an package. Deletion will be valid from the package's creation datetime. This means that the package will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
107
107
|
This method makes a synchronous HTTP request by default. To make an
|
108
108
|
asynchronous HTTP request, please pass async_req=True
|
109
109
|
|
@@ -219,15 +219,15 @@ class PackagesApi:
|
|
219
219
|
|
220
220
|
|
221
221
|
@overload
|
222
|
-
async def get_package(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the package belongs.")], code : Annotated[StrictStr, Field(..., description="The package's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Package\" domain to decorate onto the package.
|
222
|
+
async def get_package(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the package belongs.")], code : Annotated[StrictStr, Field(..., description="The package's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Package\" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\".")] = None, **kwargs) -> Package: # noqa: E501
|
223
223
|
...
|
224
224
|
|
225
225
|
@overload
|
226
|
-
def get_package(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the package belongs.")], code : Annotated[StrictStr, Field(..., description="The package's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Package\" domain to decorate onto the package.
|
226
|
+
def get_package(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the package belongs.")], code : Annotated[StrictStr, Field(..., description="The package's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Package\" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> Package: # noqa: E501
|
227
227
|
...
|
228
228
|
|
229
229
|
@validate_arguments
|
230
|
-
def get_package(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the package belongs.")], code : Annotated[StrictStr, Field(..., description="The package's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Package\" domain to decorate onto the package.
|
230
|
+
def get_package(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the package belongs.")], code : Annotated[StrictStr, Field(..., description="The package's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Package\" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Package, Awaitable[Package]]: # noqa: E501
|
231
231
|
"""[EXPERIMENTAL] GetPackage: Get Package # noqa: E501
|
232
232
|
|
233
233
|
Fetch a Package that matches the specified identifier # noqa: E501
|
@@ -243,7 +243,7 @@ class PackagesApi:
|
|
243
243
|
:type code: str
|
244
244
|
:param as_at: The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.
|
245
245
|
:type as_at: datetime
|
246
|
-
:param property_keys: A list of property keys from the \"Package\" domain to decorate onto the package.
|
246
|
+
:param property_keys: A list of property keys from the \"Package\" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\".
|
247
247
|
:type property_keys: List[str]
|
248
248
|
:param async_req: Whether to execute the request asynchronously.
|
249
249
|
:type async_req: bool, optional
|
@@ -264,7 +264,7 @@ class PackagesApi:
|
|
264
264
|
return self.get_package_with_http_info(scope, code, as_at, property_keys, **kwargs) # noqa: E501
|
265
265
|
|
266
266
|
@validate_arguments
|
267
|
-
def get_package_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the package belongs.")], code : Annotated[StrictStr, Field(..., description="The package's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Package\" domain to decorate onto the package.
|
267
|
+
def get_package_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the package belongs.")], code : Annotated[StrictStr, Field(..., description="The package's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Package\" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
268
268
|
"""[EXPERIMENTAL] GetPackage: Get Package # noqa: E501
|
269
269
|
|
270
270
|
Fetch a Package that matches the specified identifier # noqa: E501
|
@@ -280,7 +280,7 @@ class PackagesApi:
|
|
280
280
|
:type code: str
|
281
281
|
:param as_at: The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.
|
282
282
|
:type as_at: datetime
|
283
|
-
:param property_keys: A list of property keys from the \"Package\" domain to decorate onto the package.
|
283
|
+
:param property_keys: A list of property keys from the \"Package\" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\".
|
284
284
|
:type property_keys: List[str]
|
285
285
|
:param async_req: Whether to execute the request asynchronously.
|
286
286
|
:type async_req: bool, optional
|
@@ -399,15 +399,15 @@ class PackagesApi:
|
|
399
399
|
|
400
400
|
|
401
401
|
@overload
|
402
|
-
async def list_packages(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing packages from a previous call to list packages.
|
402
|
+
async def list_packages(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Package\" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> PagedResourceListOfPackage: # noqa: E501
|
403
403
|
...
|
404
404
|
|
405
405
|
@overload
|
406
|
-
def list_packages(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing packages from a previous call to list packages.
|
406
|
+
def list_packages(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Package\" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPackage: # noqa: E501
|
407
407
|
...
|
408
408
|
|
409
409
|
@validate_arguments
|
410
|
-
def list_packages(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing packages from a previous call to list packages.
|
410
|
+
def list_packages(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Package\" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPackage, Awaitable[PagedResourceListOfPackage]]: # noqa: E501
|
411
411
|
"""[EXPERIMENTAL] ListPackages: List Packages # noqa: E501
|
412
412
|
|
413
413
|
Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). # noqa: E501
|
@@ -419,15 +419,15 @@ class PackagesApi:
|
|
419
419
|
|
420
420
|
:param as_at: The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.
|
421
421
|
:type as_at: datetime
|
422
|
-
:param page: The pagination token to use to continue listing packages from a previous call to list packages.
|
422
|
+
:param page: The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
423
423
|
:type page: str
|
424
424
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
425
425
|
:type sort_by: List[str]
|
426
426
|
:param limit: When paginating, limit the number of returned results to this many.
|
427
427
|
:type limit: int
|
428
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
428
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
429
429
|
:type filter: str
|
430
|
-
:param property_keys: A list of property keys from the \"Package\" domain to decorate onto each package.
|
430
|
+
:param property_keys: A list of property keys from the \"Package\" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
431
431
|
:type property_keys: List[str]
|
432
432
|
:param async_req: Whether to execute the request asynchronously.
|
433
433
|
:type async_req: bool, optional
|
@@ -448,7 +448,7 @@ class PackagesApi:
|
|
448
448
|
return self.list_packages_with_http_info(as_at, page, sort_by, limit, filter, property_keys, **kwargs) # noqa: E501
|
449
449
|
|
450
450
|
@validate_arguments
|
451
|
-
def list_packages_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing packages from a previous call to list packages.
|
451
|
+
def list_packages_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = 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, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Package\" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
452
452
|
"""[EXPERIMENTAL] ListPackages: List Packages # noqa: E501
|
453
453
|
|
454
454
|
Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). # noqa: E501
|
@@ -460,15 +460,15 @@ class PackagesApi:
|
|
460
460
|
|
461
461
|
:param as_at: The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.
|
462
462
|
:type as_at: datetime
|
463
|
-
:param page: The pagination token to use to continue listing packages from a previous call to list packages.
|
463
|
+
:param page: The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
464
464
|
:type page: str
|
465
465
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
466
466
|
:type sort_by: List[str]
|
467
467
|
:param limit: When paginating, limit the number of returned results to this many.
|
468
468
|
:type limit: int
|
469
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
469
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
470
470
|
:type filter: str
|
471
|
-
:param property_keys: A list of property keys from the \"Package\" domain to decorate onto each package.
|
471
|
+
:param property_keys: A list of property keys from the \"Package\" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
472
472
|
:type property_keys: List[str]
|
473
473
|
:param async_req: Whether to execute the request asynchronously.
|
474
474
|
:type async_req: bool, optional
|
lusid/api/participations_api.py
CHANGED
@@ -70,7 +70,7 @@ class ParticipationsApi:
|
|
70
70
|
def delete_participation(self, scope : Annotated[StrictStr, Field(..., description="The participation scope.")], code : Annotated[StrictStr, Field(..., description="The participation's code. This, together with the scope uniquely identifies the participation to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
71
71
|
"""[EARLY ACCESS] DeleteParticipation: Delete participation # noqa: E501
|
72
72
|
|
73
|
-
Delete an participation. Deletion will be valid from the participation's creation datetime.
|
73
|
+
Delete an participation. Deletion will be valid from the participation's creation datetime. This means that the participation will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
74
74
|
This method makes a synchronous HTTP request by default. To make an
|
75
75
|
asynchronous HTTP request, please pass async_req=True
|
76
76
|
|
@@ -103,7 +103,7 @@ class ParticipationsApi:
|
|
103
103
|
def delete_participation_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The participation scope.")], code : Annotated[StrictStr, Field(..., description="The participation's code. This, together with the scope uniquely identifies the participation to delete.")], **kwargs) -> ApiResponse: # noqa: E501
|
104
104
|
"""[EARLY ACCESS] DeleteParticipation: Delete participation # noqa: E501
|
105
105
|
|
106
|
-
Delete an participation. Deletion will be valid from the participation's creation datetime.
|
106
|
+
Delete an participation. Deletion will be valid from the participation's creation datetime. This means that the participation will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
107
107
|
This method makes a synchronous HTTP request by default. To make an
|
108
108
|
asynchronous HTTP request, please pass async_req=True
|
109
109
|
|
@@ -219,15 +219,15 @@ class ParticipationsApi:
|
|
219
219
|
|
220
220
|
|
221
221
|
@overload
|
222
|
-
async def get_participation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the participation belongs.")], code : Annotated[StrictStr, Field(..., description="The participation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Participation\" domain to decorate onto the participation.
|
222
|
+
async def get_participation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the participation belongs.")], code : Annotated[StrictStr, Field(..., description="The participation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Participation\" domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\".")] = None, **kwargs) -> Participation: # noqa: E501
|
223
223
|
...
|
224
224
|
|
225
225
|
@overload
|
226
|
-
def get_participation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the participation belongs.")], code : Annotated[StrictStr, Field(..., description="The participation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Participation\" domain to decorate onto the participation.
|
226
|
+
def get_participation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the participation belongs.")], code : Annotated[StrictStr, Field(..., description="The participation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Participation\" domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> Participation: # noqa: E501
|
227
227
|
...
|
228
228
|
|
229
229
|
@validate_arguments
|
230
|
-
def get_participation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the participation belongs.")], code : Annotated[StrictStr, Field(..., description="The participation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Participation\" domain to decorate onto the participation.
|
230
|
+
def get_participation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the participation belongs.")], code : Annotated[StrictStr, Field(..., description="The participation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Participation\" domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Participation, Awaitable[Participation]]: # noqa: E501
|
231
231
|
"""[EARLY ACCESS] GetParticipation: Get Participation # noqa: E501
|
232
232
|
|
233
233
|
Fetch a Participation that matches the specified identifier # noqa: E501
|
@@ -243,7 +243,7 @@ class ParticipationsApi:
|
|
243
243
|
:type code: str
|
244
244
|
:param as_at: The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
|
245
245
|
:type as_at: datetime
|
246
|
-
:param property_keys: A list of property keys from the \"Participation\" domain to decorate onto the participation.
|
246
|
+
:param property_keys: A list of property keys from the \"Participation\" domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\".
|
247
247
|
:type property_keys: List[str]
|
248
248
|
:param async_req: Whether to execute the request asynchronously.
|
249
249
|
:type async_req: bool, optional
|
@@ -264,7 +264,7 @@ class ParticipationsApi:
|
|
264
264
|
return self.get_participation_with_http_info(scope, code, as_at, property_keys, **kwargs) # noqa: E501
|
265
265
|
|
266
266
|
@validate_arguments
|
267
|
-
def get_participation_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the participation belongs.")], code : Annotated[StrictStr, Field(..., description="The participation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Participation\" domain to decorate onto the participation.
|
267
|
+
def get_participation_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the participation belongs.")], code : Annotated[StrictStr, Field(..., description="The participation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Participation\" domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
268
268
|
"""[EARLY ACCESS] GetParticipation: Get Participation # noqa: E501
|
269
269
|
|
270
270
|
Fetch a Participation that matches the specified identifier # noqa: E501
|
@@ -280,7 +280,7 @@ class ParticipationsApi:
|
|
280
280
|
:type code: str
|
281
281
|
:param as_at: The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
|
282
282
|
:type as_at: datetime
|
283
|
-
:param property_keys: A list of property keys from the \"Participation\" domain to decorate onto the participation.
|
283
|
+
:param property_keys: A list of property keys from the \"Participation\" domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\".
|
284
284
|
:type property_keys: List[str]
|
285
285
|
:param async_req: Whether to execute the request asynchronously.
|
286
286
|
:type async_req: bool, optional
|
@@ -399,15 +399,15 @@ class ParticipationsApi:
|
|
399
399
|
|
400
400
|
|
401
401
|
@overload
|
402
|
-
async def list_participations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing participations from a previous call to list participations.
|
402
|
+
async def list_participations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing participations from a previous call to list participations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Participation\" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> PagedResourceListOfParticipation: # noqa: E501
|
403
403
|
...
|
404
404
|
|
405
405
|
@overload
|
406
|
-
def list_participations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing participations from a previous call to list participations.
|
406
|
+
def list_participations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing participations from a previous call to list participations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Participation\" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfParticipation: # noqa: E501
|
407
407
|
...
|
408
408
|
|
409
409
|
@validate_arguments
|
410
|
-
def list_participations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing participations from a previous call to list participations.
|
410
|
+
def list_participations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing participations from a previous call to list participations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Participation\" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfParticipation, Awaitable[PagedResourceListOfParticipation]]: # noqa: E501
|
411
411
|
"""[EARLY ACCESS] ListParticipations: List Participations # noqa: E501
|
412
412
|
|
413
413
|
Fetch the last pre-AsAt date version of each Participation in scope (does not fetch the entire history). # noqa: E501
|
@@ -419,15 +419,15 @@ class ParticipationsApi:
|
|
419
419
|
|
420
420
|
:param as_at: The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
|
421
421
|
:type as_at: datetime
|
422
|
-
:param page: The pagination token to use to continue listing participations from a previous call to list participations.
|
422
|
+
:param page: The pagination token to use to continue listing participations from a previous call to list participations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
423
423
|
:type page: str
|
424
424
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
425
425
|
:type sort_by: List[str]
|
426
426
|
:param limit: When paginating, limit the number of returned results to this many.
|
427
427
|
:type limit: int
|
428
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
428
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
429
429
|
:type filter: str
|
430
|
-
:param property_keys: A list of property keys from the \"Participation\" domain to decorate onto each participation.
|
430
|
+
:param property_keys: A list of property keys from the \"Participation\" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
431
431
|
:type property_keys: List[str]
|
432
432
|
:param async_req: Whether to execute the request asynchronously.
|
433
433
|
:type async_req: bool, optional
|
@@ -448,7 +448,7 @@ class ParticipationsApi:
|
|
448
448
|
return self.list_participations_with_http_info(as_at, page, sort_by, limit, filter, property_keys, **kwargs) # noqa: E501
|
449
449
|
|
450
450
|
@validate_arguments
|
451
|
-
def list_participations_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing participations from a previous call to list participations.
|
451
|
+
def list_participations_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing participations from a previous call to list participations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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 \"Participation\" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
452
452
|
"""[EARLY ACCESS] ListParticipations: List Participations # noqa: E501
|
453
453
|
|
454
454
|
Fetch the last pre-AsAt date version of each Participation in scope (does not fetch the entire history). # noqa: E501
|
@@ -460,15 +460,15 @@ class ParticipationsApi:
|
|
460
460
|
|
461
461
|
:param as_at: The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
|
462
462
|
:type as_at: datetime
|
463
|
-
:param page: The pagination token to use to continue listing participations from a previous call to list participations.
|
463
|
+
:param page: The pagination token to use to continue listing participations from a previous call to list participations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
464
464
|
:type page: str
|
465
465
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
466
466
|
:type sort_by: List[str]
|
467
467
|
:param limit: When paginating, limit the number of returned results to this many.
|
468
468
|
:type limit: int
|
469
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
469
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
470
470
|
:type filter: str
|
471
|
-
:param property_keys: A list of property keys from the \"Participation\" domain to decorate onto each participation.
|
471
|
+
:param property_keys: A list of property keys from the \"Participation\" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
472
472
|
:type property_keys: List[str]
|
473
473
|
:param async_req: Whether to execute the request asynchronously.
|
474
474
|
:type async_req: bool, optional
|