lusid-sdk 2.0.50b0__py3-none-any.whl → 2.0.470__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.
Potentially problematic release.
This version of lusid-sdk might be problematic. Click here for more details.
- lusid/__init__.py +1117 -14
- lusid/api/__init__.py +69 -0
- lusid/api/abor_api.py +513 -179
- lusid/api/abor_configuration_api.py +25 -24
- lusid/api/allocations_api.py +12 -20
- lusid/api/blocks_api.py +6 -6
- lusid/api/calendars_api.py +16 -24
- lusid/api/chart_of_accounts_api.py +1745 -441
- lusid/api/compliance_api.py +71 -62
- lusid/api/configuration_recipe_api.py +1198 -56
- lusid/api/corporate_action_sources_api.py +8 -8
- lusid/api/custom_entities_api.py +6 -6
- lusid/api/cut_label_definitions_api.py +9 -17
- lusid/api/data_types_api.py +16 -32
- lusid/api/executions_api.py +6 -6
- lusid/api/funds_api.py +1119 -0
- lusid/api/instrument_event_types_api.py +1287 -0
- lusid/api/instruments_api.py +12 -20
- lusid/api/legacy_compliance_api.py +12 -12
- lusid/api/legal_entities_api.py +12 -12
- lusid/api/order_graph_api.py +12 -12
- lusid/api/order_instructions_api.py +6 -6
- lusid/api/order_management_api.py +495 -14
- lusid/api/orders_api.py +16 -24
- lusid/api/packages_api.py +6 -6
- lusid/api/persons_api.py +16 -24
- lusid/api/placements_api.py +12 -12
- lusid/api/portfolio_groups_api.py +6 -6
- lusid/api/portfolios_api.py +23 -39
- lusid/api/property_definitions_api.py +205 -0
- lusid/api/queryable_keys_api.py +211 -0
- lusid/api/quotes_api.py +20 -36
- lusid/api/reconciliations_api.py +410 -1978
- lusid/api/schemas_api.py +7 -15
- lusid/api/scopes_api.py +151 -0
- lusid/api/scripted_translation_api.py +30 -28
- lusid/api/staging_rule_set_api.py +885 -0
- lusid/api/transaction_configuration_api.py +22 -22
- lusid/api/transaction_portfolios_api.py +282 -577
- lusid/api_client.py +5 -3
- lusid/configuration.py +1 -1
- lusid/extensions/__init__.py +10 -7
- lusid/extensions/api_client.py +3 -1
- lusid/extensions/api_client_factory.py +156 -45
- lusid/extensions/api_configuration.py +124 -15
- lusid/extensions/configuration_loaders.py +2 -4
- lusid/extensions/proxy_config.py +8 -5
- lusid/extensions/socket_keep_alive.py +14 -15
- lusid/extensions/tcp_keep_alive_connector.py +93 -46
- lusid/models/__init__.py +1028 -13
- lusid/models/abor.py +9 -2
- lusid/models/abor_configuration.py +8 -8
- lusid/models/abor_configuration_request.py +9 -9
- lusid/models/abor_request.py +1 -1
- lusid/models/account.py +6 -1
- lusid/models/accumulation_event.py +104 -0
- lusid/models/address_key_compliance_parameter.py +5 -12
- lusid/models/address_key_list_compliance_parameter.py +3 -3
- lusid/models/address_key_option_definition.py +3 -1
- lusid/models/amortisation_event.py +4 -6
- lusid/models/{underlying_leg.py → asset_leg.py} +15 -15
- lusid/models/basket.py +3 -3
- lusid/models/block_and_order_id_request.py +78 -0
- lusid/models/block_and_orders.py +83 -0
- lusid/models/block_and_orders_create_request.py +77 -0
- lusid/models/block_and_orders_request.py +134 -0
- lusid/models/blocked_order_request.py +130 -0
- lusid/models/bond.py +13 -6
- lusid/models/bond_coupon_event.py +97 -0
- lusid/models/bond_default_event.py +8 -18
- lusid/models/bond_principal_event.py +97 -0
- lusid/models/book_transactions_request.py +97 -0
- lusid/models/bool_compliance_parameter.py +3 -3
- lusid/models/bool_list_compliance_parameter.py +3 -3
- lusid/models/branch_step.py +101 -0
- lusid/models/cap_floor.py +3 -3
- lusid/models/cash_dividend_event.py +32 -10
- lusid/models/cash_election.py +91 -0
- lusid/models/cash_flow_event.py +5 -7
- lusid/models/cash_perpetual.py +3 -3
- lusid/models/cds_flow_conventions.py +1 -1
- lusid/models/cds_index.py +4 -4
- lusid/models/check_step.py +110 -0
- lusid/models/cleardown_module_details.py +95 -0
- lusid/models/cleardown_module_request.py +117 -0
- lusid/models/cleardown_module_response.py +139 -0
- lusid/models/cleardown_module_rule.py +94 -0
- lusid/models/{reconciliation_run_break.py → cleardown_module_rules_updated_response.py} +30 -36
- lusid/models/close_event.py +3 -3
- lusid/models/close_period_diary_entry_request.py +149 -0
- lusid/models/complete_portfolio.py +8 -1
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +6 -5
- lusid/models/compliance_parameter.py +8 -5
- lusid/models/compliance_parameter_type.py +3 -0
- lusid/models/compliance_rule_breakdown.py +16 -8
- lusid/models/compliance_rule_breakdown_request.py +12 -4
- lusid/models/compliance_rule_result_v2.py +85 -0
- lusid/models/compliance_step.py +99 -0
- lusid/models/compliance_step_type.py +42 -0
- lusid/models/compliance_summary_rule_result.py +12 -15
- lusid/models/compliance_summary_rule_result_request.py +12 -15
- lusid/models/compliance_template_variation.py +12 -2
- lusid/models/component_transaction.py +92 -0
- lusid/models/composite_dispersion.py +30 -5
- lusid/models/compounding.py +4 -4
- lusid/models/configuration_recipe.py +10 -19
- lusid/models/constant_volatility_surface.py +102 -0
- lusid/models/contract_for_difference.py +3 -3
- lusid/models/create_derived_property_definition_request.py +3 -3
- lusid/models/create_derived_transaction_portfolio_request.py +10 -3
- lusid/models/create_property_definition_request.py +12 -5
- lusid/models/create_staging_rule_set_request.py +91 -0
- lusid/models/create_trade_tickets_response.py +87 -0
- lusid/models/create_transaction_portfolio_request.py +16 -3
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_spread_curve_data.py +4 -4
- lusid/models/custom_entity_definition.py +8 -2
- lusid/models/custom_entity_type.py +8 -2
- lusid/models/cut_label_definition.py +7 -1
- lusid/models/data_type.py +7 -1
- lusid/models/data_type_summary.py +8 -2
- lusid/models/date_time_compliance_parameter.py +3 -3
- lusid/models/date_time_list_compliance_parameter.py +3 -3
- lusid/models/{upsert_reconciliation_run_request.py → day_month.py} +15 -15
- lusid/models/decimal_compliance_parameter.py +3 -3
- lusid/models/decimal_list_compliance_parameter.py +3 -3
- lusid/models/dialect.py +9 -3
- lusid/models/diary_entry.py +1 -1
- lusid/models/diary_entry_request.py +1 -1
- lusid/models/discount_factor_curve_data.py +3 -3
- lusid/models/dividend_option_event.py +129 -0
- lusid/models/dividend_reinvestment_event.py +124 -0
- lusid/models/election_specification.py +73 -0
- lusid/models/eligibility_calculation.py +71 -0
- lusid/models/empty_model_options.py +3 -3
- lusid/models/equity.py +8 -6
- lusid/models/equity_curve_by_prices_data.py +3 -3
- lusid/models/equity_model_options.py +3 -3
- lusid/models/equity_option.py +3 -3
- lusid/models/equity_swap.py +4 -4
- lusid/models/equity_vol_surface_data.py +3 -3
- lusid/models/exchange_traded_option.py +3 -3
- lusid/models/exercise_event.py +5 -7
- lusid/models/exotic_instrument.py +3 -3
- lusid/models/expiry_event.py +91 -0
- lusid/models/filter_predicate_compliance_parameter.py +91 -0
- lusid/models/filter_step.py +101 -0
- lusid/models/fixed_leg.py +3 -3
- lusid/models/fixed_schedule.py +4 -9
- lusid/models/flexible_loan.py +105 -0
- lusid/models/float_schedule.py +20 -12
- lusid/models/floating_leg.py +3 -3
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +1 -1
- lusid/models/forward_rate_agreement.py +3 -3
- lusid/models/from_recipe.py +81 -0
- lusid/models/fund.py +182 -0
- lusid/models/fund_properties.py +115 -0
- lusid/models/fund_request.py +165 -0
- lusid/models/fund_share_class.py +99 -0
- lusid/models/funding_leg.py +3 -3
- lusid/models/funding_leg_options.py +3 -3
- lusid/models/future.py +3 -3
- lusid/models/fx_conventions.py +73 -0
- lusid/models/fx_forward.py +8 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +4 -4
- lusid/models/fx_forward_curve_data.py +3 -3
- lusid/models/fx_forward_model_options.py +3 -3
- lusid/models/fx_forward_pips_curve_data.py +3 -3
- lusid/models/fx_forward_settlement_event.py +136 -0
- lusid/models/fx_forward_tenor_curve_data.py +4 -4
- lusid/models/fx_forward_tenor_pips_curve_data.py +4 -4
- lusid/models/fx_linked_notional_schedule.py +108 -0
- lusid/models/fx_option.py +3 -3
- lusid/models/fx_rate_schedule.py +3 -3
- lusid/models/fx_swap.py +4 -4
- lusid/models/fx_vol_surface_data.py +3 -3
- lusid/models/{reconciliation_run.py → get_recipe_composer_response.py} +15 -15
- lusid/models/group_by_selector_compliance_parameter.py +91 -0
- lusid/models/group_by_step.py +101 -0
- lusid/models/group_filter_predicate_compliance_parameter.py +91 -0
- lusid/models/group_filter_step.py +110 -0
- lusid/models/group_of_market_data_key_rules.py +79 -0
- lusid/models/index_convention.py +1 -1
- lusid/models/index_model_options.py +3 -3
- lusid/models/inflation_index_conventions.py +2 -2
- lusid/models/inflation_leg.py +3 -3
- lusid/models/inflation_linked_bond.py +3 -3
- lusid/models/inflation_swap.py +4 -4
- lusid/models/informational_error_event.py +3 -3
- lusid/models/informational_event.py +4 -6
- lusid/models/instrument_event.py +13 -5
- lusid/models/instrument_event_configuration.py +74 -0
- lusid/models/instrument_event_holder.py +12 -3
- lusid/models/instrument_event_type.py +8 -0
- lusid/models/instrument_leg.py +3 -3
- lusid/models/instrument_list_compliance_parameter.py +3 -3
- lusid/models/instrument_payment_diary_leg.py +5 -3
- lusid/models/instrument_resolution_detail.py +105 -0
- lusid/models/instrument_type.py +2 -0
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +3 -3
- lusid/models/intermediate_compliance_step.py +110 -0
- lusid/models/ir_vol_cube_data.py +3 -3
- lusid/models/journal_entry_line.py +34 -3
- lusid/models/journal_entry_lines_query_parameters.py +1 -1
- lusid/models/label_value_set.py +1 -1
- lusid/models/leg_definition.py +16 -3
- lusid/models/lineage_member.py +87 -0
- lusid/models/lock_period_diary_entry_request.py +91 -0
- lusid/models/lusid_instrument.py +7 -5
- lusid/models/lusid_trade_ticket.py +8 -1
- lusid/models/market_context.py +17 -2
- lusid/models/market_data_type.py +1 -0
- lusid/models/maturity_event.py +91 -0
- lusid/models/model_options.py +5 -6
- lusid/models/model_options_type.py +0 -1
- lusid/models/model_selection.py +3 -3
- lusid/models/move_orders_to_different_blocks_request.py +77 -0
- lusid/models/moved_order_to_different_block_response.py +85 -0
- lusid/models/movement_type.py +2 -0
- lusid/models/multi_currency_amounts.py +71 -0
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/opaque_model_options.py +3 -3
- lusid/models/open_event.py +3 -3
- lusid/models/optionality_schedule.py +3 -3
- lusid/models/order_graph_block.py +4 -2
- lusid/models/order_graph_block_order_detail.py +16 -2
- lusid/models/output_transaction.py +9 -2
- lusid/models/paged_resource_list_of_cleardown_module_response.py +113 -0
- lusid/models/{paged_resource_list_of_reconciliation_run_break.py → paged_resource_list_of_cleardown_module_rule.py} +11 -11
- lusid/models/{paged_resource_list_of_reconciliation_run.py → paged_resource_list_of_fund.py} +11 -11
- lusid/models/paged_resource_list_of_property_definition.py +113 -0
- lusid/models/paged_resource_list_of_staging_rule_set.py +113 -0
- lusid/models/paged_resource_list_of_transaction_template.py +113 -0
- lusid/models/paged_resource_list_of_transaction_template_specification.py +113 -0
- lusid/models/participation_request.py +3 -9
- lusid/models/performance_returns_metric.py +1 -1
- lusid/models/period_diary_entries_reopened_response.py +104 -0
- lusid/models/place_blocks_request.py +77 -0
- lusid/models/portfolio.py +15 -2
- lusid/models/portfolio_details.py +15 -2
- lusid/models/portfolio_group_id_compliance_parameter.py +3 -3
- lusid/models/portfolio_group_id_list_compliance_parameter.py +3 -3
- lusid/models/portfolio_holding.py +27 -2
- lusid/models/portfolio_id_compliance_parameter.py +3 -3
- lusid/models/portfolio_id_list_compliance_parameter.py +3 -3
- lusid/models/posting_module_rule.py +29 -4
- lusid/models/pricing_model.py +2 -1
- lusid/models/property_definition.py +17 -4
- lusid/models/property_definition_search_result.py +3 -3
- lusid/models/property_domain.py +3 -0
- lusid/models/property_key_compliance_parameter.py +3 -3
- lusid/models/property_key_list_compliance_parameter.py +3 -3
- lusid/models/queryable_key.py +124 -0
- lusid/models/raw_vendor_event.py +5 -7
- lusid/models/re_open_period_diary_entry_request.py +84 -0
- lusid/models/recipe_block.py +87 -0
- lusid/models/recipe_composer.py +100 -0
- lusid/models/{reconciliation_break_id.py → recipe_value.py} +22 -23
- lusid/models/recombine_step.py +101 -0
- lusid/models/reference_instrument.py +3 -3
- lusid/models/relative_date_offset.py +71 -0
- lusid/models/repo.py +3 -3
- lusid/models/reset_event.py +4 -6
- lusid/models/resource_list_of_block_and_orders.py +113 -0
- lusid/models/resource_list_of_get_recipe_composer_response.py +113 -0
- lusid/models/resource_list_of_moved_order_to_different_block_response.py +113 -0
- lusid/models/resource_list_of_queryable_key.py +113 -0
- lusid/models/schedule.py +6 -5
- lusid/models/schedule_type.py +1 -0
- lusid/models/script_map_reference.py +94 -0
- lusid/models/security_election.py +86 -0
- lusid/models/set_share_class_instruments_request.py +79 -0
- lusid/models/side_definition.py +1 -8
- lusid/models/sides_definition_request.py +1 -8
- lusid/models/simple_cash_flow_loan.py +3 -3
- lusid/models/simple_instrument.py +3 -3
- lusid/models/staging_rule.py +90 -0
- lusid/models/staging_rule_approval_criteria.py +81 -0
- lusid/models/staging_rule_match_criteria.py +95 -0
- lusid/models/staging_rule_set.py +103 -0
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_split_event.py +3 -3
- lusid/models/string_compliance_parameter.py +3 -3
- lusid/models/string_list_compliance_parameter.py +3 -3
- lusid/models/template_field.py +77 -0
- lusid/models/term_deposit.py +3 -3
- lusid/models/total_return_swap.py +16 -16
- lusid/models/transaction_configuration_movement_data.py +3 -3
- lusid/models/transaction_configuration_movement_data_request.py +3 -3
- lusid/models/transaction_currency_and_amount.py +81 -0
- lusid/models/transaction_field_map.py +97 -0
- lusid/models/transaction_price.py +3 -3
- lusid/models/transaction_price_and_type.py +81 -0
- lusid/models/transaction_price_type.py +1 -0
- lusid/models/transaction_property_map.py +80 -0
- lusid/models/transaction_template.py +100 -0
- lusid/models/transaction_template_request.py +79 -0
- lusid/models/transaction_template_specification.py +99 -0
- lusid/models/transaction_type_alias.py +0 -7
- lusid/models/transaction_type_calculation.py +1 -1
- lusid/models/transition_event.py +3 -3
- lusid/models/translation_context.py +75 -0
- lusid/models/translation_script.py +9 -3
- lusid/models/trial_balance.py +46 -11
- lusid/models/trial_balance_query_parameters.py +15 -6
- lusid/models/trigger_event.py +3 -3
- lusid/models/units_ratio.py +71 -0
- lusid/models/update_staging_rule_set_request.py +91 -0
- lusid/models/{compliance_run_summary.py → upsert_compliance_run_summary_result.py} +8 -8
- lusid/models/upsert_dialect_request.py +79 -0
- lusid/models/upsert_instrument_event_request.py +12 -3
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_composer_request.py +73 -0
- lusid/models/upsert_recipe_request.py +3 -9
- lusid/models/upsert_translation_script_request.py +75 -0
- lusid/models/valuation_schedule.py +10 -3
- lusid/models/weighted_instrument.py +13 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +89 -0
- lusid/models/yield_curve_data.py +3 -3
- lusid/rest.py +1 -1
- {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.470.dist-info}/METADATA +245 -48
- {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.470.dist-info}/RECORD +326 -235
- {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.470.dist-info}/WHEEL +1 -1
- lusid/extensions/api_client_builder.py +0 -138
- lusid/models/configuration_recipe_snippet.py +0 -139
- lusid/models/je_lines_query_parameters.py +0 -105
- lusid/models/look_up_pricing_model_options.py +0 -93
- lusid/models/reconciliation_run_id.py +0 -85
- lusid/models/upsert_reconciliation_break_request.py +0 -98
lusid/api/orders_api.py
CHANGED
|
@@ -22,7 +22,7 @@ from typing import overload, Optional, Union, Awaitable
|
|
|
22
22
|
from typing_extensions import Annotated
|
|
23
23
|
from datetime import datetime
|
|
24
24
|
|
|
25
|
-
from pydantic import Field,
|
|
25
|
+
from pydantic import Field, StrictStr, conint, conlist, constr, validator
|
|
26
26
|
|
|
27
27
|
from typing import Optional
|
|
28
28
|
|
|
@@ -223,7 +223,7 @@ class OrdersApi:
|
|
|
223
223
|
def get_order(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the order belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), 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
|
|
224
224
|
"""[EARLY ACCESS] GetOrder: Get Order # noqa: E501
|
|
225
225
|
|
|
226
|
-
Fetch an Order that matches the specified identifier # noqa: E501
|
|
226
|
+
Fetch an Order that matches the specified identifier. # noqa: E501
|
|
227
227
|
This method makes a synchronous HTTP request by default. To make an
|
|
228
228
|
asynchronous HTTP request, please pass async_req=True
|
|
229
229
|
|
|
@@ -261,7 +261,7 @@ class OrdersApi:
|
|
|
261
261
|
def get_order_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the order belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), 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
|
|
262
262
|
"""[EARLY ACCESS] GetOrder: Get Order # noqa: E501
|
|
263
263
|
|
|
264
|
-
Fetch an Order that matches the specified identifier # noqa: E501
|
|
264
|
+
Fetch an Order that matches the specified identifier. # noqa: E501
|
|
265
265
|
This method makes a synchronous HTTP request by default. To make an
|
|
266
266
|
asynchronous HTTP request, please pass async_req=True
|
|
267
267
|
|
|
@@ -391,32 +391,30 @@ class OrdersApi:
|
|
|
391
391
|
_request_auth=_params.get('_request_auth'))
|
|
392
392
|
|
|
393
393
|
@overload
|
|
394
|
-
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[constr(strict=True, max_length=500, min_length=1)], 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.
|
|
394
|
+
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, **kwargs) -> PagedResourceListOfOrder: # noqa: E501
|
|
395
395
|
...
|
|
396
396
|
|
|
397
397
|
@overload
|
|
398
|
-
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[constr(strict=True, max_length=500, min_length=1)], 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.
|
|
398
|
+
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfOrder: # noqa: E501
|
|
399
399
|
...
|
|
400
400
|
|
|
401
401
|
@validate_arguments
|
|
402
|
-
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[constr(strict=True, max_length=500, min_length=1)], 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.
|
|
402
|
+
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfOrder, Awaitable[PagedResourceListOfOrder]]: # noqa: E501
|
|
403
403
|
"""[EARLY ACCESS] ListOrders: List Orders # noqa: E501
|
|
404
404
|
|
|
405
|
-
Fetch the last pre-AsAt date version of each order
|
|
405
|
+
Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). # noqa: E501
|
|
406
406
|
This method makes a synchronous HTTP request by default. To make an
|
|
407
407
|
asynchronous HTTP request, please pass async_req=True
|
|
408
408
|
|
|
409
|
-
>>> thread = api.list_orders(as_at, page, sort_by,
|
|
409
|
+
>>> thread = api.list_orders(as_at, page, sort_by, limit, filter, property_keys, async_req=True)
|
|
410
410
|
>>> result = thread.get()
|
|
411
411
|
|
|
412
412
|
:param as_at: The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
|
|
413
413
|
:type as_at: datetime
|
|
414
|
-
: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.
|
|
414
|
+
: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.
|
|
415
415
|
:type page: str
|
|
416
|
-
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
|
416
|
+
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
|
417
417
|
:type sort_by: List[str]
|
|
418
|
-
:param start: When paginating, skip this number of results.
|
|
419
|
-
:type start: int
|
|
420
418
|
:param limit: When paginating, limit the number of returned results to this many.
|
|
421
419
|
:type limit: int
|
|
422
420
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
|
@@ -440,27 +438,25 @@ class OrdersApi:
|
|
|
440
438
|
raise ValueError(message)
|
|
441
439
|
if async_req is not None:
|
|
442
440
|
kwargs['async_req'] = async_req
|
|
443
|
-
return self.list_orders_with_http_info(as_at, page, sort_by,
|
|
441
|
+
return self.list_orders_with_http_info(as_at, page, sort_by, limit, filter, property_keys, **kwargs) # noqa: E501
|
|
444
442
|
|
|
445
443
|
@validate_arguments
|
|
446
|
-
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[constr(strict=True, max_length=500, min_length=1)], 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.
|
|
444
|
+
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
447
445
|
"""[EARLY ACCESS] ListOrders: List Orders # noqa: E501
|
|
448
446
|
|
|
449
|
-
Fetch the last pre-AsAt date version of each order
|
|
447
|
+
Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). # noqa: E501
|
|
450
448
|
This method makes a synchronous HTTP request by default. To make an
|
|
451
449
|
asynchronous HTTP request, please pass async_req=True
|
|
452
450
|
|
|
453
|
-
>>> thread = api.list_orders_with_http_info(as_at, page, sort_by,
|
|
451
|
+
>>> thread = api.list_orders_with_http_info(as_at, page, sort_by, limit, filter, property_keys, async_req=True)
|
|
454
452
|
>>> result = thread.get()
|
|
455
453
|
|
|
456
454
|
:param as_at: The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
|
|
457
455
|
:type as_at: datetime
|
|
458
|
-
: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.
|
|
456
|
+
: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.
|
|
459
457
|
:type page: str
|
|
460
|
-
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
|
458
|
+
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
|
461
459
|
:type sort_by: List[str]
|
|
462
|
-
:param start: When paginating, skip this number of results.
|
|
463
|
-
:type start: int
|
|
464
460
|
:param limit: When paginating, limit the number of returned results to this many.
|
|
465
461
|
:type limit: int
|
|
466
462
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
|
@@ -498,7 +494,6 @@ class OrdersApi:
|
|
|
498
494
|
'as_at',
|
|
499
495
|
'page',
|
|
500
496
|
'sort_by',
|
|
501
|
-
'start',
|
|
502
497
|
'limit',
|
|
503
498
|
'filter',
|
|
504
499
|
'property_keys'
|
|
@@ -545,9 +540,6 @@ class OrdersApi:
|
|
|
545
540
|
_query_params.append(('sortBy', _params['sort_by']))
|
|
546
541
|
_collection_formats['sortBy'] = 'multi'
|
|
547
542
|
|
|
548
|
-
if _params.get('start') is not None: # noqa: E501
|
|
549
|
-
_query_params.append(('start', _params['start']))
|
|
550
|
-
|
|
551
543
|
if _params.get('limit') is not None: # noqa: E501
|
|
552
544
|
_query_params.append(('limit', _params['limit']))
|
|
553
545
|
|
lusid/api/packages_api.py
CHANGED
|
@@ -391,15 +391,15 @@ class PackagesApi:
|
|
|
391
391
|
_request_auth=_params.get('_request_auth'))
|
|
392
392
|
|
|
393
393
|
@overload
|
|
394
|
-
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, **kwargs) -> PagedResourceListOfPackage: # noqa: E501
|
|
394
|
+
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, **kwargs) -> PagedResourceListOfPackage: # noqa: E501
|
|
395
395
|
...
|
|
396
396
|
|
|
397
397
|
@overload
|
|
398
|
-
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPackage: # noqa: E501
|
|
398
|
+
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPackage: # noqa: E501
|
|
399
399
|
...
|
|
400
400
|
|
|
401
401
|
@validate_arguments
|
|
402
|
-
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPackage, Awaitable[PagedResourceListOfPackage]]: # noqa: E501
|
|
402
|
+
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPackage, Awaitable[PagedResourceListOfPackage]]: # noqa: E501
|
|
403
403
|
"""[EXPERIMENTAL] ListPackages: List Packages # noqa: E501
|
|
404
404
|
|
|
405
405
|
Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). # noqa: E501
|
|
@@ -413,7 +413,7 @@ class PackagesApi:
|
|
|
413
413
|
:type as_at: datetime
|
|
414
414
|
: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.
|
|
415
415
|
:type page: str
|
|
416
|
-
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
|
416
|
+
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
|
417
417
|
:type sort_by: List[str]
|
|
418
418
|
:param limit: When paginating, limit the number of returned results to this many.
|
|
419
419
|
:type limit: int
|
|
@@ -441,7 +441,7 @@ class PackagesApi:
|
|
|
441
441
|
return self.list_packages_with_http_info(as_at, page, sort_by, limit, filter, property_keys, **kwargs) # noqa: E501
|
|
442
442
|
|
|
443
443
|
@validate_arguments
|
|
444
|
-
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
444
|
+
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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
445
445
|
"""[EXPERIMENTAL] ListPackages: List Packages # noqa: E501
|
|
446
446
|
|
|
447
447
|
Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). # noqa: E501
|
|
@@ -455,7 +455,7 @@ class PackagesApi:
|
|
|
455
455
|
:type as_at: datetime
|
|
456
456
|
: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.
|
|
457
457
|
:type page: str
|
|
458
|
-
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
|
458
|
+
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
|
459
459
|
:type sort_by: List[str]
|
|
460
460
|
:param limit: When paginating, limit the number of returned results to this many.
|
|
461
461
|
:type limit: int
|
lusid/api/persons_api.py
CHANGED
|
@@ -22,7 +22,7 @@ from typing import overload, Optional, Union, Awaitable
|
|
|
22
22
|
from typing_extensions import Annotated
|
|
23
23
|
from datetime import datetime
|
|
24
24
|
|
|
25
|
-
from pydantic import Field,
|
|
25
|
+
from pydantic import Field, StrictStr, conint, conlist, constr, validator
|
|
26
26
|
|
|
27
27
|
from typing import Dict, List, Optional
|
|
28
28
|
|
|
@@ -1991,15 +1991,15 @@ class PersonsApi:
|
|
|
1991
1991
|
_request_auth=_params.get('_request_auth'))
|
|
1992
1992
|
|
|
1993
1993
|
@overload
|
|
1994
|
-
async def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
1994
|
+
async def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" 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 \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ResourceListOfPerson: # noqa: E501
|
|
1995
1995
|
...
|
|
1996
1996
|
|
|
1997
1997
|
@overload
|
|
1998
|
-
def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
1998
|
+
def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" 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 \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPerson: # noqa: E501
|
|
1999
1999
|
...
|
|
2000
2000
|
|
|
2001
2001
|
@validate_arguments
|
|
2002
|
-
def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2002
|
+
def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" 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 \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPerson, Awaitable[ResourceListOfPerson]]: # noqa: E501
|
|
2003
2003
|
"""[EARLY ACCESS] ListAllPersons: List All Persons # noqa: E501
|
|
2004
2004
|
|
|
2005
2005
|
List all persons which the user is entitled to see. # noqa: E501
|
|
@@ -2013,7 +2013,7 @@ class PersonsApi:
|
|
|
2013
2013
|
:type effective_at: str
|
|
2014
2014
|
:param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
|
|
2015
2015
|
:type as_at: datetime
|
|
2016
|
-
:param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2016
|
+
:param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2017
2017
|
:type page: str
|
|
2018
2018
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
|
|
2019
2019
|
:type limit: int
|
|
@@ -2043,7 +2043,7 @@ class PersonsApi:
|
|
|
2043
2043
|
return self.list_all_persons_with_http_info(effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
|
2044
2044
|
|
|
2045
2045
|
@validate_arguments
|
|
2046
|
-
def list_all_persons_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2046
|
+
def list_all_persons_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" 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 \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
2047
2047
|
"""[EARLY ACCESS] ListAllPersons: List All Persons # noqa: E501
|
|
2048
2048
|
|
|
2049
2049
|
List all persons which the user is entitled to see. # noqa: E501
|
|
@@ -2057,7 +2057,7 @@ class PersonsApi:
|
|
|
2057
2057
|
:type effective_at: str
|
|
2058
2058
|
:param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
|
|
2059
2059
|
:type as_at: datetime
|
|
2060
|
-
:param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2060
|
+
:param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2061
2061
|
:type page: str
|
|
2062
2062
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
|
|
2063
2063
|
:type limit: int
|
|
@@ -2195,22 +2195,22 @@ class PersonsApi:
|
|
|
2195
2195
|
_request_auth=_params.get('_request_auth'))
|
|
2196
2196
|
|
|
2197
2197
|
@overload
|
|
2198
|
-
async def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2198
|
+
async def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" 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 \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> PagedResourceListOfPerson: # noqa: E501
|
|
2199
2199
|
...
|
|
2200
2200
|
|
|
2201
2201
|
@overload
|
|
2202
|
-
def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2202
|
+
def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" 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 \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPerson: # noqa: E501
|
|
2203
2203
|
...
|
|
2204
2204
|
|
|
2205
2205
|
@validate_arguments
|
|
2206
|
-
def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2206
|
+
def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" 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 \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPerson, Awaitable[PagedResourceListOfPerson]]: # noqa: E501
|
|
2207
2207
|
"""[EARLY ACCESS] ListPersons: List Persons # noqa: E501
|
|
2208
2208
|
|
|
2209
2209
|
List persons which have identifiers of a specific identifier type's scope and code, and satisfies filter criteria. # noqa: E501
|
|
2210
2210
|
This method makes a synchronous HTTP request by default. To make an
|
|
2211
2211
|
asynchronous HTTP request, please pass async_req=True
|
|
2212
2212
|
|
|
2213
|
-
>>> thread = api.list_persons(id_type_scope, id_type_code, effective_at, as_at, page,
|
|
2213
|
+
>>> thread = api.list_persons(id_type_scope, id_type_code, effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, async_req=True)
|
|
2214
2214
|
>>> result = thread.get()
|
|
2215
2215
|
|
|
2216
2216
|
:param id_type_scope: Scope of the person identifier type. (required)
|
|
@@ -2221,10 +2221,8 @@ class PersonsApi:
|
|
|
2221
2221
|
:type effective_at: str
|
|
2222
2222
|
:param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
|
|
2223
2223
|
:type as_at: datetime
|
|
2224
|
-
:param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2224
|
+
:param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2225
2225
|
:type page: str
|
|
2226
|
-
:param start: When paginating, skip this number of results.
|
|
2227
|
-
:type start: int
|
|
2228
2226
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
|
2229
2227
|
:type limit: int
|
|
2230
2228
|
:param filter: Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
|
@@ -2250,17 +2248,17 @@ class PersonsApi:
|
|
|
2250
2248
|
raise ValueError(message)
|
|
2251
2249
|
if async_req is not None:
|
|
2252
2250
|
kwargs['async_req'] = async_req
|
|
2253
|
-
return self.list_persons_with_http_info(id_type_scope, id_type_code, effective_at, as_at, page,
|
|
2251
|
+
return self.list_persons_with_http_info(id_type_scope, id_type_code, effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, **kwargs) # noqa: E501
|
|
2254
2252
|
|
|
2255
2253
|
@validate_arguments
|
|
2256
|
-
def list_persons_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2254
|
+
def list_persons_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" 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 \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
2257
2255
|
"""[EARLY ACCESS] ListPersons: List Persons # noqa: E501
|
|
2258
2256
|
|
|
2259
2257
|
List persons which have identifiers of a specific identifier type's scope and code, and satisfies filter criteria. # noqa: E501
|
|
2260
2258
|
This method makes a synchronous HTTP request by default. To make an
|
|
2261
2259
|
asynchronous HTTP request, please pass async_req=True
|
|
2262
2260
|
|
|
2263
|
-
>>> thread = api.list_persons_with_http_info(id_type_scope, id_type_code, effective_at, as_at, page,
|
|
2261
|
+
>>> thread = api.list_persons_with_http_info(id_type_scope, id_type_code, effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, async_req=True)
|
|
2264
2262
|
>>> result = thread.get()
|
|
2265
2263
|
|
|
2266
2264
|
:param id_type_scope: Scope of the person identifier type. (required)
|
|
@@ -2271,10 +2269,8 @@ class PersonsApi:
|
|
|
2271
2269
|
:type effective_at: str
|
|
2272
2270
|
:param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
|
|
2273
2271
|
:type as_at: datetime
|
|
2274
|
-
:param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2272
|
+
:param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
|
|
2275
2273
|
:type page: str
|
|
2276
|
-
:param start: When paginating, skip this number of results.
|
|
2277
|
-
:type start: int
|
|
2278
2274
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
|
2279
2275
|
:type limit: int
|
|
2280
2276
|
:param filter: Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
|
@@ -2316,7 +2312,6 @@ class PersonsApi:
|
|
|
2316
2312
|
'effective_at',
|
|
2317
2313
|
'as_at',
|
|
2318
2314
|
'page',
|
|
2319
|
-
'start',
|
|
2320
2315
|
'limit',
|
|
2321
2316
|
'filter',
|
|
2322
2317
|
'property_keys',
|
|
@@ -2369,9 +2364,6 @@ class PersonsApi:
|
|
|
2369
2364
|
if _params.get('page') is not None: # noqa: E501
|
|
2370
2365
|
_query_params.append(('page', _params['page']))
|
|
2371
2366
|
|
|
2372
|
-
if _params.get('start') is not None: # noqa: E501
|
|
2373
|
-
_query_params.append(('start', _params['start']))
|
|
2374
|
-
|
|
2375
2367
|
if _params.get('limit') is not None: # noqa: E501
|
|
2376
2368
|
_query_params.append(('limit', _params['limit']))
|
|
2377
2369
|
|
lusid/api/placements_api.py
CHANGED
|
@@ -212,15 +212,15 @@ class PlacementsApi:
|
|
|
212
212
|
_request_auth=_params.get('_request_auth'))
|
|
213
213
|
|
|
214
214
|
@overload
|
|
215
|
-
async def get_placement(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the placement belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The placement's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Placement\" domain to decorate onto the placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, **kwargs) -> Placement: # noqa: E501
|
|
215
|
+
async def get_placement(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the placement belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The placement's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Placement\" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\". Property keys from the instrument domain can also be decorated onto the placement, e.g. \"Instrument/default/Isin\". These are only decorated if requested.")] = None, **kwargs) -> Placement: # noqa: E501
|
|
216
216
|
...
|
|
217
217
|
|
|
218
218
|
@overload
|
|
219
|
-
def get_placement(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the placement belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The placement's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Placement\" domain to decorate onto the placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> Placement: # noqa: E501
|
|
219
|
+
def get_placement(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the placement belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The placement's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Placement\" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\". Property keys from the instrument domain can also be decorated onto the placement, e.g. \"Instrument/default/Isin\". These are only decorated if requested.")] = None, async_req: Optional[bool]=True, **kwargs) -> Placement: # noqa: E501
|
|
220
220
|
...
|
|
221
221
|
|
|
222
222
|
@validate_arguments
|
|
223
|
-
def get_placement(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the placement belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The placement's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Placement\" domain to decorate onto the placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Placement, Awaitable[Placement]]: # noqa: E501
|
|
223
|
+
def get_placement(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the placement belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The placement's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Placement\" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\". Property keys from the instrument domain can also be decorated onto the placement, e.g. \"Instrument/default/Isin\". These are only decorated if requested.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Placement, Awaitable[Placement]]: # noqa: E501
|
|
224
224
|
"""[EARLY ACCESS] GetPlacement: Get Placement # noqa: E501
|
|
225
225
|
|
|
226
226
|
Fetch a Placement that matches the specified identifier # noqa: E501
|
|
@@ -236,7 +236,7 @@ class PlacementsApi:
|
|
|
236
236
|
:type code: str
|
|
237
237
|
:param as_at: The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.
|
|
238
238
|
:type as_at: datetime
|
|
239
|
-
:param property_keys: A list of property keys from the \"Placement\" domain to decorate onto the placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".
|
|
239
|
+
:param property_keys: A list of property keys from the \"Placement\" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\". Property keys from the instrument domain can also be decorated onto the placement, e.g. \"Instrument/default/Isin\". These are only decorated if requested.
|
|
240
240
|
:type property_keys: List[str]
|
|
241
241
|
:param async_req: Whether to execute the request asynchronously.
|
|
242
242
|
:type async_req: bool, optional
|
|
@@ -258,7 +258,7 @@ class PlacementsApi:
|
|
|
258
258
|
return self.get_placement_with_http_info(scope, code, as_at, property_keys, **kwargs) # noqa: E501
|
|
259
259
|
|
|
260
260
|
@validate_arguments
|
|
261
|
-
def get_placement_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the placement belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The placement's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Placement\" domain to decorate onto the placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
261
|
+
def get_placement_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to which the placement belongs.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The placement's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Placement\" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\". Property keys from the instrument domain can also be decorated onto the placement, e.g. \"Instrument/default/Isin\". These are only decorated if requested.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
262
262
|
"""[EARLY ACCESS] GetPlacement: Get Placement # noqa: E501
|
|
263
263
|
|
|
264
264
|
Fetch a Placement that matches the specified identifier # noqa: E501
|
|
@@ -274,7 +274,7 @@ class PlacementsApi:
|
|
|
274
274
|
:type code: str
|
|
275
275
|
:param as_at: The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.
|
|
276
276
|
:type as_at: datetime
|
|
277
|
-
:param property_keys: A list of property keys from the \"Placement\" domain to decorate onto the placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".
|
|
277
|
+
:param property_keys: A list of property keys from the \"Placement\" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\". Property keys from the instrument domain can also be decorated onto the placement, e.g. \"Instrument/default/Isin\". These are only decorated if requested.
|
|
278
278
|
:type property_keys: List[str]
|
|
279
279
|
:param async_req: Whether to execute the request asynchronously.
|
|
280
280
|
:type async_req: bool, optional
|
|
@@ -391,15 +391,15 @@ class PlacementsApi:
|
|
|
391
391
|
_request_auth=_params.get('_request_auth'))
|
|
392
392
|
|
|
393
393
|
@overload
|
|
394
|
-
async def list_placements(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing placements from a previous call to list placements. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, **kwargs) -> PagedResourceListOfPlacement: # noqa: E501
|
|
394
|
+
async def list_placements(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing placements from a previous call to list placements. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, **kwargs) -> PagedResourceListOfPlacement: # noqa: E501
|
|
395
395
|
...
|
|
396
396
|
|
|
397
397
|
@overload
|
|
398
|
-
def list_placements(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing placements from a previous call to list placements. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPlacement: # noqa: E501
|
|
398
|
+
def list_placements(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing placements from a previous call to list placements. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPlacement: # noqa: E501
|
|
399
399
|
...
|
|
400
400
|
|
|
401
401
|
@validate_arguments
|
|
402
|
-
def list_placements(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing placements from a previous call to list placements. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPlacement, Awaitable[PagedResourceListOfPlacement]]: # noqa: E501
|
|
402
|
+
def list_placements(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing placements from a previous call to list placements. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPlacement, Awaitable[PagedResourceListOfPlacement]]: # noqa: E501
|
|
403
403
|
"""[EARLY ACCESS] ListPlacements: List Placements # noqa: E501
|
|
404
404
|
|
|
405
405
|
Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history). # noqa: E501
|
|
@@ -413,7 +413,7 @@ class PlacementsApi:
|
|
|
413
413
|
:type as_at: datetime
|
|
414
414
|
:param page: The pagination token to use to continue listing placements from a previous call to list placements. 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.
|
|
415
415
|
:type page: str
|
|
416
|
-
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
|
416
|
+
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
|
417
417
|
:type sort_by: List[str]
|
|
418
418
|
:param limit: When paginating, limit the number of returned results to this many.
|
|
419
419
|
:type limit: int
|
|
@@ -441,7 +441,7 @@ class PlacementsApi:
|
|
|
441
441
|
return self.list_placements_with_http_info(as_at, page, sort_by, limit, filter, property_keys, **kwargs) # noqa: E501
|
|
442
442
|
|
|
443
443
|
@validate_arguments
|
|
444
|
-
def list_placements_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing placements from a previous call to list placements. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
444
|
+
def list_placements_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing placements from a previous call to list placements. 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
445
445
|
"""[EARLY ACCESS] ListPlacements: List Placements # noqa: E501
|
|
446
446
|
|
|
447
447
|
Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history). # noqa: E501
|
|
@@ -455,7 +455,7 @@ class PlacementsApi:
|
|
|
455
455
|
:type as_at: datetime
|
|
456
456
|
:param page: The pagination token to use to continue listing placements from a previous call to list placements. 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.
|
|
457
457
|
:type page: str
|
|
458
|
-
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
|
458
|
+
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
|
459
459
|
:type sort_by: List[str]
|
|
460
460
|
:param limit: When paginating, limit the number of returned results to this many.
|
|
461
461
|
:type limit: int
|