lusid-sdk 2.1.910__py3-none-any.whl → 2.1.912__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +126 -126
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_holding.py +6 -2
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +6 -4
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/settlement_schedule.py +20 -2
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/WHEEL +0 -0
@@ -383,15 +383,15 @@ class PropertyDefinitionsApi:
|
|
383
383
|
|
384
384
|
|
385
385
|
@overload
|
386
|
-
async def delete_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property to be deleted.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the property to be deleted. Together with the domain and scope this uniquely
|
386
|
+
async def delete_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property to be deleted.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
|
387
387
|
...
|
388
388
|
|
389
389
|
@overload
|
390
|
-
def delete_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property to be deleted.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the property to be deleted. Together with the domain and scope this uniquely
|
390
|
+
def delete_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property to be deleted.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
391
391
|
...
|
392
392
|
|
393
393
|
@validate_arguments
|
394
|
-
def delete_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property to be deleted.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the property to be deleted. Together with the domain and scope this uniquely
|
394
|
+
def delete_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property to be deleted.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
395
395
|
"""DeletePropertyDefinition: Delete property definition # noqa: E501
|
396
396
|
|
397
397
|
Delete the definition of the specified property. # noqa: E501
|
@@ -405,7 +405,7 @@ class PropertyDefinitionsApi:
|
|
405
405
|
:type domain: str
|
406
406
|
:param scope: The scope of the property to be deleted. (required)
|
407
407
|
:type scope: str
|
408
|
-
:param code: The code of the property to be deleted. Together with the domain and scope this uniquely
|
408
|
+
:param code: The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property. (required)
|
409
409
|
:type code: str
|
410
410
|
:param async_req: Whether to execute the request asynchronously.
|
411
411
|
:type async_req: bool, optional
|
@@ -426,7 +426,7 @@ class PropertyDefinitionsApi:
|
|
426
426
|
return self.delete_property_definition_with_http_info(domain, scope, code, **kwargs) # noqa: E501
|
427
427
|
|
428
428
|
@validate_arguments
|
429
|
-
def delete_property_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property to be deleted.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the property to be deleted. Together with the domain and scope this uniquely
|
429
|
+
def delete_property_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property to be deleted.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property to be deleted.")], code : Annotated[StrictStr, Field(..., description="The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property.")], **kwargs) -> ApiResponse: # noqa: E501
|
430
430
|
"""DeletePropertyDefinition: Delete property definition # noqa: E501
|
431
431
|
|
432
432
|
Delete the definition of the specified property. # noqa: E501
|
@@ -440,7 +440,7 @@ class PropertyDefinitionsApi:
|
|
440
440
|
:type domain: str
|
441
441
|
:param scope: The scope of the property to be deleted. (required)
|
442
442
|
:type scope: str
|
443
|
-
:param code: The code of the property to be deleted. Together with the domain and scope this uniquely
|
443
|
+
:param code: The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property. (required)
|
444
444
|
:type code: str
|
445
445
|
:param async_req: Whether to execute the request asynchronously.
|
446
446
|
:type async_req: bool, optional
|
@@ -551,18 +551,18 @@ class PropertyDefinitionsApi:
|
|
551
551
|
|
552
552
|
|
553
553
|
@overload
|
554
|
-
async def delete_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to delete properties from.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to delete properties from.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format
|
554
|
+
async def delete_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to delete properties from.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to delete properties from.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
555
555
|
...
|
556
556
|
|
557
557
|
@overload
|
558
|
-
def delete_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to delete properties from.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to delete properties from.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format
|
558
|
+
def delete_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to delete properties from.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to delete properties from.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
559
559
|
...
|
560
560
|
|
561
561
|
@validate_arguments
|
562
|
-
def delete_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to delete properties from.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to delete properties from.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format
|
562
|
+
def delete_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to delete properties from.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to delete properties from.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
563
563
|
"""[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties # noqa: E501
|
564
564
|
|
565
|
-
Delete one or more properties from a single property definition. If the properties are time-variant then an effective date time from which the
|
565
|
+
Delete one or more properties from a single property definition. If the properties are time-variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. # noqa: E501
|
566
566
|
This method makes a synchronous HTTP request by default. To make an
|
567
567
|
asynchronous HTTP request, please pass async_req=True
|
568
568
|
|
@@ -575,9 +575,9 @@ class PropertyDefinitionsApi:
|
|
575
575
|
:type scope: str
|
576
576
|
:param code: The code of the property definition to delete properties from. (required)
|
577
577
|
:type code: str
|
578
|
-
:param request_body: The property keys of the properties to delete. These must take the format
|
578
|
+
:param request_body: The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain. (required)
|
579
579
|
:type request_body: List[str]
|
580
|
-
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from.
|
580
|
+
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual.
|
581
581
|
:type effective_at: str
|
582
582
|
:param async_req: Whether to execute the request asynchronously.
|
583
583
|
:type async_req: bool, optional
|
@@ -598,10 +598,10 @@ class PropertyDefinitionsApi:
|
|
598
598
|
return self.delete_property_definition_properties_with_http_info(domain, scope, code, request_body, effective_at, **kwargs) # noqa: E501
|
599
599
|
|
600
600
|
@validate_arguments
|
601
|
-
def delete_property_definition_properties_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to delete properties from.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to delete properties from.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format
|
601
|
+
def delete_property_definition_properties_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to delete properties from.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to delete properties from.")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to delete properties from.")], request_body : Annotated[conlist(StrictStr), Field(..., description="The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
602
602
|
"""[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties # noqa: E501
|
603
603
|
|
604
|
-
Delete one or more properties from a single property definition. If the properties are time-variant then an effective date time from which the
|
604
|
+
Delete one or more properties from a single property definition. If the properties are time-variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. # noqa: E501
|
605
605
|
This method makes a synchronous HTTP request by default. To make an
|
606
606
|
asynchronous HTTP request, please pass async_req=True
|
607
607
|
|
@@ -614,9 +614,9 @@ class PropertyDefinitionsApi:
|
|
614
614
|
:type scope: str
|
615
615
|
:param code: The code of the property definition to delete properties from. (required)
|
616
616
|
:type code: str
|
617
|
-
:param request_body: The property keys of the properties to delete. These must take the format
|
617
|
+
:param request_body: The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain. (required)
|
618
618
|
:type request_body: List[str]
|
619
|
-
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from.
|
619
|
+
:param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual.
|
620
620
|
:type effective_at: str
|
621
621
|
:param async_req: Whether to execute the request asynchronously.
|
622
622
|
:type async_req: bool, optional
|
@@ -742,15 +742,15 @@ class PropertyDefinitionsApi:
|
|
742
742
|
|
743
743
|
|
744
744
|
@overload
|
745
|
-
async def get_multiple_property_definitions(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should
|
745
|
+
async def get_multiple_property_definitions(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Lifetime, use \"lifeTime eq 'Perpetual'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> ResourceListOfPropertyDefinition: # noqa: E501
|
746
746
|
...
|
747
747
|
|
748
748
|
@overload
|
749
|
-
def get_multiple_property_definitions(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should
|
749
|
+
def get_multiple_property_definitions(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Lifetime, use \"lifeTime eq 'Perpetual'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyDefinition: # noqa: E501
|
750
750
|
...
|
751
751
|
|
752
752
|
@validate_arguments
|
753
|
-
def get_multiple_property_definitions(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should
|
753
|
+
def get_multiple_property_definitions(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Lifetime, use \"lifeTime eq 'Perpetual'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyDefinition, Awaitable[ResourceListOfPropertyDefinition]]: # noqa: E501
|
754
754
|
"""GetMultiplePropertyDefinitions: Get multiple property definitions # noqa: E501
|
755
755
|
|
756
756
|
Retrieve the definition of one or more specified properties. # noqa: E501
|
@@ -760,13 +760,13 @@ class PropertyDefinitionsApi:
|
|
760
760
|
>>> thread = api.get_multiple_property_definitions(property_keys, as_at, filter, effective_at, async_req=True)
|
761
761
|
>>> result = thread.get()
|
762
762
|
|
763
|
-
:param property_keys: One or more property keys which identify each property that a definition should
|
763
|
+
:param property_keys: One or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'. (required)
|
764
764
|
:type property_keys: List[str]
|
765
|
-
:param as_at: The asAt datetime at which to retrieve the property definitions. Defaults to return
|
765
|
+
:param as_at: The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified.
|
766
766
|
:type as_at: datetime
|
767
|
-
:param filter: Expression to filter the result set.
|
767
|
+
:param filter: Expression to filter the result set. For example, to filter on the Lifetime, use \"lifeTime eq 'Perpetual'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
768
768
|
:type filter: str
|
769
|
-
:param effective_at: The effective datetime or cut label at which to list properties attached to the Property Definition.
|
769
|
+
:param effective_at: The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.
|
770
770
|
:type effective_at: str
|
771
771
|
:param async_req: Whether to execute the request asynchronously.
|
772
772
|
:type async_req: bool, optional
|
@@ -787,7 +787,7 @@ class PropertyDefinitionsApi:
|
|
787
787
|
return self.get_multiple_property_definitions_with_http_info(property_keys, as_at, filter, effective_at, **kwargs) # noqa: E501
|
788
788
|
|
789
789
|
@validate_arguments
|
790
|
-
def get_multiple_property_definitions_with_http_info(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should
|
790
|
+
def get_multiple_property_definitions_with_http_info(self, property_keys : Annotated[conlist(StrictStr), Field(..., description="One or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Lifetime, use \"lifeTime eq 'Perpetual'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
791
791
|
"""GetMultiplePropertyDefinitions: Get multiple property definitions # noqa: E501
|
792
792
|
|
793
793
|
Retrieve the definition of one or more specified properties. # noqa: E501
|
@@ -797,13 +797,13 @@ class PropertyDefinitionsApi:
|
|
797
797
|
>>> thread = api.get_multiple_property_definitions_with_http_info(property_keys, as_at, filter, effective_at, async_req=True)
|
798
798
|
>>> result = thread.get()
|
799
799
|
|
800
|
-
:param property_keys: One or more property keys which identify each property that a definition should
|
800
|
+
:param property_keys: One or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'. (required)
|
801
801
|
:type property_keys: List[str]
|
802
|
-
:param as_at: The asAt datetime at which to retrieve the property definitions. Defaults to return
|
802
|
+
:param as_at: The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified.
|
803
803
|
:type as_at: datetime
|
804
|
-
:param filter: Expression to filter the result set.
|
804
|
+
:param filter: Expression to filter the result set. For example, to filter on the Lifetime, use \"lifeTime eq 'Perpetual'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
805
805
|
:type filter: str
|
806
|
-
:param effective_at: The effective datetime or cut label at which to list properties attached to the Property Definition.
|
806
|
+
:param effective_at: The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.
|
807
807
|
:type effective_at: str
|
808
808
|
:param async_req: Whether to execute the request asynchronously.
|
809
809
|
:type async_req: bool, optional
|
@@ -922,15 +922,15 @@ class PropertyDefinitionsApi:
|
|
922
922
|
|
923
923
|
|
924
924
|
@overload
|
925
|
-
async def get_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely
|
925
|
+
async def get_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely identifies the property.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> PropertyDefinition: # noqa: E501
|
926
926
|
...
|
927
927
|
|
928
928
|
@overload
|
929
|
-
def get_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely
|
929
|
+
def get_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely identifies the property.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> PropertyDefinition: # noqa: E501
|
930
930
|
...
|
931
931
|
|
932
932
|
@validate_arguments
|
933
|
-
def get_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely
|
933
|
+
def get_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely identifies the property.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PropertyDefinition, Awaitable[PropertyDefinition]]: # noqa: E501
|
934
934
|
"""GetPropertyDefinition: Get property definition # noqa: E501
|
935
935
|
|
936
936
|
Retrieve the definition of a specified property. # noqa: E501
|
@@ -944,11 +944,11 @@ class PropertyDefinitionsApi:
|
|
944
944
|
:type domain: str
|
945
945
|
:param scope: The scope of the specified property. (required)
|
946
946
|
:type scope: str
|
947
|
-
:param code: The code of the specified property. Together with the domain and scope this uniquely
|
947
|
+
:param code: The code of the specified property. Together with the domain and scope this uniquely identifies the property. (required)
|
948
948
|
:type code: str
|
949
|
-
:param as_at: The asAt datetime at which to retrieve the property definition. Defaults to return
|
949
|
+
:param as_at: The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified.
|
950
950
|
:type as_at: datetime
|
951
|
-
:param effective_at: The effective datetime or cut label at which to list properties attached to the Property Definition.
|
951
|
+
:param effective_at: The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.
|
952
952
|
:type effective_at: str
|
953
953
|
:param async_req: Whether to execute the request asynchronously.
|
954
954
|
:type async_req: bool, optional
|
@@ -969,7 +969,7 @@ class PropertyDefinitionsApi:
|
|
969
969
|
return self.get_property_definition_with_http_info(domain, scope, code, as_at, effective_at, **kwargs) # noqa: E501
|
970
970
|
|
971
971
|
@validate_arguments
|
972
|
-
def get_property_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely
|
972
|
+
def get_property_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely identifies the property.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
973
973
|
"""GetPropertyDefinition: Get property definition # noqa: E501
|
974
974
|
|
975
975
|
Retrieve the definition of a specified property. # noqa: E501
|
@@ -983,11 +983,11 @@ class PropertyDefinitionsApi:
|
|
983
983
|
:type domain: str
|
984
984
|
:param scope: The scope of the specified property. (required)
|
985
985
|
:type scope: str
|
986
|
-
:param code: The code of the specified property. Together with the domain and scope this uniquely
|
986
|
+
:param code: The code of the specified property. Together with the domain and scope this uniquely identifies the property. (required)
|
987
987
|
:type code: str
|
988
|
-
:param as_at: The asAt datetime at which to retrieve the property definition. Defaults to return
|
988
|
+
:param as_at: The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified.
|
989
989
|
:type as_at: datetime
|
990
|
-
:param effective_at: The effective datetime or cut label at which to list properties attached to the Property Definition.
|
990
|
+
:param effective_at: The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime if not specified.
|
991
991
|
:type effective_at: str
|
992
992
|
:param async_req: Whether to execute the request asynchronously.
|
993
993
|
:type async_req: bool, optional
|
@@ -1109,15 +1109,15 @@ class PropertyDefinitionsApi:
|
|
1109
1109
|
|
1110
1110
|
|
1111
1111
|
@overload
|
1112
|
-
async def get_property_definition_property_time_series(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to which the property is attached")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to which the property is attached")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to which the property is attached")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format
|
1112
|
+
async def get_property_definition_property_time_series(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to which the property is attached")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to which the property is attached")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to which the property is attached")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format {domain}/{scope}/{code}, for example \"PropertyDefinition/myScope/someAttributeKey\".")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to the current datetime if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
|
1113
1113
|
...
|
1114
1114
|
|
1115
1115
|
@overload
|
1116
|
-
def get_property_definition_property_time_series(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to which the property is attached")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to which the property is attached")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to which the property is attached")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format
|
1116
|
+
def get_property_definition_property_time_series(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to which the property is attached")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to which the property is attached")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to which the property is attached")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format {domain}/{scope}/{code}, for example \"PropertyDefinition/myScope/someAttributeKey\".")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to the current datetime if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
|
1117
1117
|
...
|
1118
1118
|
|
1119
1119
|
@validate_arguments
|
1120
|
-
def get_property_definition_property_time_series(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to which the property is attached")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to which the property is attached")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to which the property is attached")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format
|
1120
|
+
def get_property_definition_property_time_series(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to which the property is attached")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to which the property is attached")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to which the property is attached")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format {domain}/{scope}/{code}, for example \"PropertyDefinition/myScope/someAttributeKey\".")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to the current datetime if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
|
1121
1121
|
"""[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series # noqa: E501
|
1122
1122
|
|
1123
1123
|
List the complete time series of a property definition property. # noqa: E501
|
@@ -1133,13 +1133,13 @@ class PropertyDefinitionsApi:
|
|
1133
1133
|
:type scope: str
|
1134
1134
|
:param code: The code of the property definition to which the property is attached (required)
|
1135
1135
|
:type code: str
|
1136
|
-
:param property_key: The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format
|
1136
|
+
:param property_key: The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format {domain}/{scope}/{code}, for example \"PropertyDefinition/myScope/someAttributeKey\". (required)
|
1137
1137
|
:type property_key: str
|
1138
1138
|
:param as_at: The asAt datetime at which to show the history. Defaults to the current datetime if not specified.
|
1139
1139
|
:type as_at: datetime
|
1140
1140
|
:param filter: Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
1141
1141
|
:type filter: str
|
1142
|
-
:param page: The pagination token to use to continue listing properties from a previous call to get property time series.
|
1142
|
+
:param page: The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
|
1143
1143
|
:type page: str
|
1144
1144
|
:param limit: When paginating, limit the number of returned results to this many.
|
1145
1145
|
:type limit: int
|
@@ -1162,7 +1162,7 @@ class PropertyDefinitionsApi:
|
|
1162
1162
|
return self.get_property_definition_property_time_series_with_http_info(domain, scope, code, property_key, as_at, filter, page, limit, **kwargs) # noqa: E501
|
1163
1163
|
|
1164
1164
|
@validate_arguments
|
1165
|
-
def get_property_definition_property_time_series_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to which the property is attached")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to which the property is attached")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to which the property is attached")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format
|
1165
|
+
def get_property_definition_property_time_series_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property definition to which the property is attached")], scope : Annotated[StrictStr, Field(..., description="The scope of the property definition to which the property is attached")], code : Annotated[StrictStr, Field(..., description="The code of the property definition to which the property is attached")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format {domain}/{scope}/{code}, for example \"PropertyDefinition/myScope/someAttributeKey\".")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to the current datetime if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1166
1166
|
"""[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series # noqa: E501
|
1167
1167
|
|
1168
1168
|
List the complete time series of a property definition property. # noqa: E501
|
@@ -1178,13 +1178,13 @@ class PropertyDefinitionsApi:
|
|
1178
1178
|
:type scope: str
|
1179
1179
|
:param code: The code of the property definition to which the property is attached (required)
|
1180
1180
|
:type code: str
|
1181
|
-
:param property_key: The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format
|
1181
|
+
:param property_key: The property key of the property whose history to show. This must be from the \"Property Definition\" domain and in the format {domain}/{scope}/{code}, for example \"PropertyDefinition/myScope/someAttributeKey\". (required)
|
1182
1182
|
:type property_key: str
|
1183
1183
|
:param as_at: The asAt datetime at which to show the history. Defaults to the current datetime if not specified.
|
1184
1184
|
:type as_at: datetime
|
1185
1185
|
:param filter: Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
1186
1186
|
:type filter: str
|
1187
|
-
:param page: The pagination token to use to continue listing properties from a previous call to get property time series.
|
1187
|
+
:param page: The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
|
1188
1188
|
:type page: str
|
1189
1189
|
:param limit: When paginating, limit the number of returned results to this many.
|
1190
1190
|
:type limit: int
|
@@ -1320,15 +1320,15 @@ class PropertyDefinitionsApi:
|
|
1320
1320
|
|
1321
1321
|
|
1322
1322
|
@overload
|
1323
|
-
async def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID
|
1323
|
+
async def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the property definitions. 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 property definitions. Defaults to returning the latest version of each property definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> PagedResourceListOfPropertyDefinition: # noqa: E501
|
1324
1324
|
...
|
1325
1325
|
|
1326
1326
|
@overload
|
1327
|
-
def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID
|
1327
|
+
def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the property definitions. 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 property definitions. Defaults to returning the latest version of each property definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPropertyDefinition: # noqa: E501
|
1328
1328
|
...
|
1329
1329
|
|
1330
1330
|
@validate_arguments
|
1331
|
-
def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID
|
1331
|
+
def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the property definitions. 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 property definitions. Defaults to returning the latest version of each property definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPropertyDefinition, Awaitable[PagedResourceListOfPropertyDefinition]]: # noqa: E501
|
1332
1332
|
"""ListPropertyDefinitions: List property definitions # noqa: E501
|
1333
1333
|
|
1334
1334
|
List all the property definitions matching particular criteria. # noqa: E501
|
@@ -1338,17 +1338,17 @@ class PropertyDefinitionsApi:
|
|
1338
1338
|
>>> thread = api.list_property_definitions(effective_at, as_at, property_keys, page, limit, filter, sort_by, async_req=True)
|
1339
1339
|
>>> result = thread.get()
|
1340
1340
|
|
1341
|
-
:param effective_at: The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID
|
1341
|
+
:param effective_at: The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.
|
1342
1342
|
:type effective_at: str
|
1343
|
-
:param as_at: The asAt datetime at which to list the property definitions. Defaults to returning the latest version
|
1343
|
+
:param as_at: The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.
|
1344
1344
|
:type as_at: datetime
|
1345
|
-
:param property_keys: A list of property keys from the 'Property Definition' domain to decorate onto
|
1345
|
+
:param property_keys: A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.
|
1346
1346
|
:type property_keys: List[str]
|
1347
|
-
:param page: The pagination token to use to continue listing property definitions; this
|
1347
|
+
:param page: The pagination token to use to continue listing property definitions; 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.
|
1348
1348
|
:type page: str
|
1349
1349
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
1350
1350
|
:type limit: int
|
1351
|
-
:param filter: Expression to filter the results.
|
1351
|
+
:param filter: Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
1352
1352
|
:type filter: str
|
1353
1353
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1354
1354
|
:type sort_by: List[str]
|
@@ -1371,7 +1371,7 @@ class PropertyDefinitionsApi:
|
|
1371
1371
|
return self.list_property_definitions_with_http_info(effective_at, as_at, property_keys, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
1372
1372
|
|
1373
1373
|
@validate_arguments
|
1374
|
-
def list_property_definitions_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID
|
1374
|
+
def list_property_definitions_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the property definitions. 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 property definitions. Defaults to returning the latest version of each property definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1375
1375
|
"""ListPropertyDefinitions: List property definitions # noqa: E501
|
1376
1376
|
|
1377
1377
|
List all the property definitions matching particular criteria. # noqa: E501
|
@@ -1381,17 +1381,17 @@ class PropertyDefinitionsApi:
|
|
1381
1381
|
>>> thread = api.list_property_definitions_with_http_info(effective_at, as_at, property_keys, page, limit, filter, sort_by, async_req=True)
|
1382
1382
|
>>> result = thread.get()
|
1383
1383
|
|
1384
|
-
:param effective_at: The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID
|
1384
|
+
:param effective_at: The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.
|
1385
1385
|
:type effective_at: str
|
1386
|
-
:param as_at: The asAt datetime at which to list the property definitions. Defaults to returning the latest version
|
1386
|
+
:param as_at: The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.
|
1387
1387
|
:type as_at: datetime
|
1388
|
-
:param property_keys: A list of property keys from the 'Property Definition' domain to decorate onto
|
1388
|
+
:param property_keys: A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.
|
1389
1389
|
:type property_keys: List[str]
|
1390
|
-
:param page: The pagination token to use to continue listing property definitions; this
|
1390
|
+
:param page: The pagination token to use to continue listing property definitions; 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.
|
1391
1391
|
:type page: str
|
1392
1392
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
1393
1393
|
:type limit: int
|
1394
|
-
:param filter: Expression to filter the results.
|
1394
|
+
:param filter: Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
1395
1395
|
:type filter: str
|
1396
1396
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1397
1397
|
:type sort_by: List[str]
|
@@ -1708,18 +1708,18 @@ class PropertyDefinitionsApi:
|
|
1708
1708
|
|
1709
1709
|
|
1710
1710
|
@overload
|
1711
|
-
async def update_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property being updated.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the property being updated. Together with the domain and scope this uniquely
|
1711
|
+
async def update_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property being updated.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the property being updated. Together with the domain and scope this uniquely identifies the property.")], update_property_definition_request : Annotated[UpdatePropertyDefinitionRequest, Field(..., description="The updated definition of the property.")], **kwargs) -> PropertyDefinition: # noqa: E501
|
1712
1712
|
...
|
1713
1713
|
|
1714
1714
|
@overload
|
1715
|
-
def update_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property being updated.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the property being updated. Together with the domain and scope this uniquely
|
1715
|
+
def update_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property being updated.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the property being updated. Together with the domain and scope this uniquely identifies the property.")], update_property_definition_request : Annotated[UpdatePropertyDefinitionRequest, Field(..., description="The updated definition of the property.")], async_req: Optional[bool]=True, **kwargs) -> PropertyDefinition: # noqa: E501
|
1716
1716
|
...
|
1717
1717
|
|
1718
1718
|
@validate_arguments
|
1719
|
-
def update_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property being updated.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the property being updated. Together with the domain and scope this uniquely
|
1719
|
+
def update_property_definition(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property being updated.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the property being updated. Together with the domain and scope this uniquely identifies the property.")], update_property_definition_request : Annotated[UpdatePropertyDefinitionRequest, Field(..., description="The updated definition of the property.")], async_req: Optional[bool]=None, **kwargs) -> Union[PropertyDefinition, Awaitable[PropertyDefinition]]: # noqa: E501
|
1720
1720
|
"""UpdatePropertyDefinition: Update property definition # noqa: E501
|
1721
1721
|
|
1722
|
-
Update the definition of a specified existing property. Not all elements within a property definition
|
1722
|
+
Update the definition of a specified existing property. Not all elements within a property definition are modifiable due to the potential implications for values already stored against the property. # noqa: E501
|
1723
1723
|
This method makes a synchronous HTTP request by default. To make an
|
1724
1724
|
asynchronous HTTP request, please pass async_req=True
|
1725
1725
|
|
@@ -1730,7 +1730,7 @@ class PropertyDefinitionsApi:
|
|
1730
1730
|
:type domain: str
|
1731
1731
|
:param scope: The scope of the property being updated. (required)
|
1732
1732
|
:type scope: str
|
1733
|
-
:param code: The code of the property being updated. Together with the domain and scope this uniquely
|
1733
|
+
:param code: The code of the property being updated. Together with the domain and scope this uniquely identifies the property. (required)
|
1734
1734
|
:type code: str
|
1735
1735
|
:param update_property_definition_request: The updated definition of the property. (required)
|
1736
1736
|
:type update_property_definition_request: UpdatePropertyDefinitionRequest
|
@@ -1753,10 +1753,10 @@ class PropertyDefinitionsApi:
|
|
1753
1753
|
return self.update_property_definition_with_http_info(domain, scope, code, update_property_definition_request, **kwargs) # noqa: E501
|
1754
1754
|
|
1755
1755
|
@validate_arguments
|
1756
|
-
def update_property_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property being updated.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the property being updated. Together with the domain and scope this uniquely
|
1756
|
+
def update_property_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the property being updated.")], scope : Annotated[StrictStr, Field(..., description="The scope of the property being updated.")], code : Annotated[StrictStr, Field(..., description="The code of the property being updated. Together with the domain and scope this uniquely identifies the property.")], update_property_definition_request : Annotated[UpdatePropertyDefinitionRequest, Field(..., description="The updated definition of the property.")], **kwargs) -> ApiResponse: # noqa: E501
|
1757
1757
|
"""UpdatePropertyDefinition: Update property definition # noqa: E501
|
1758
1758
|
|
1759
|
-
Update the definition of a specified existing property. Not all elements within a property definition
|
1759
|
+
Update the definition of a specified existing property. Not all elements within a property definition are modifiable due to the potential implications for values already stored against the property. # noqa: E501
|
1760
1760
|
This method makes a synchronous HTTP request by default. To make an
|
1761
1761
|
asynchronous HTTP request, please pass async_req=True
|
1762
1762
|
|
@@ -1767,7 +1767,7 @@ class PropertyDefinitionsApi:
|
|
1767
1767
|
:type domain: str
|
1768
1768
|
:param scope: The scope of the property being updated. (required)
|
1769
1769
|
:type scope: str
|
1770
|
-
:param code: The code of the property being updated. Together with the domain and scope this uniquely
|
1770
|
+
:param code: The code of the property being updated. Together with the domain and scope this uniquely identifies the property. (required)
|
1771
1771
|
:type code: str
|
1772
1772
|
:param update_property_definition_request: The updated definition of the property. (required)
|
1773
1773
|
:type update_property_definition_request: UpdatePropertyDefinitionRequest
|
@@ -1891,15 +1891,15 @@ class PropertyDefinitionsApi:
|
|
1891
1891
|
|
1892
1892
|
|
1893
1893
|
@overload
|
1894
|
-
async def upsert_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in
|
1894
|
+
async def upsert_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'PropertyDefinition/Manager/Id'.")], success_mode : Annotated[Optional[StrictStr], Field( description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, **kwargs) -> BatchUpsertPropertyDefinitionPropertiesResponse: # noqa: E501
|
1895
1895
|
...
|
1896
1896
|
|
1897
1897
|
@overload
|
1898
|
-
def upsert_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in
|
1898
|
+
def upsert_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'PropertyDefinition/Manager/Id'.")], success_mode : Annotated[Optional[StrictStr], Field( description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchUpsertPropertyDefinitionPropertiesResponse: # noqa: E501
|
1899
1899
|
...
|
1900
1900
|
|
1901
1901
|
@validate_arguments
|
1902
|
-
def upsert_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in
|
1902
|
+
def upsert_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'PropertyDefinition/Manager/Id'.")], success_mode : Annotated[Optional[StrictStr], Field( description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpsertPropertyDefinitionPropertiesResponse, Awaitable[BatchUpsertPropertyDefinitionPropertiesResponse]]: # noqa: E501
|
1903
1903
|
"""UpsertPropertyDefinitionProperties: Upsert properties to a property definition # noqa: E501
|
1904
1904
|
|
1905
1905
|
Create or update properties for a particular property definition # noqa: E501
|
@@ -1915,7 +1915,7 @@ class PropertyDefinitionsApi:
|
|
1915
1915
|
:type scope: str
|
1916
1916
|
:param code: The code of the specified property. Together with the domain and scope this uniquely (required)
|
1917
1917
|
:type code: str
|
1918
|
-
:param request_body: The properties to be created or updated. Each property in
|
1918
|
+
:param request_body: The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'PropertyDefinition/Manager/Id'. (required)
|
1919
1919
|
:type request_body: Dict[str, ModelProperty]
|
1920
1920
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
|
1921
1921
|
:type success_mode: str
|
@@ -1938,7 +1938,7 @@ class PropertyDefinitionsApi:
|
|
1938
1938
|
return self.upsert_property_definition_properties_with_http_info(domain, scope, code, request_body, success_mode, **kwargs) # noqa: E501
|
1939
1939
|
|
1940
1940
|
@validate_arguments
|
1941
|
-
def upsert_property_definition_properties_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in
|
1941
|
+
def upsert_property_definition_properties_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified property.")], code : Annotated[StrictStr, Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'PropertyDefinition/Manager/Id'.")], success_mode : Annotated[Optional[StrictStr], Field( description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1942
1942
|
"""UpsertPropertyDefinitionProperties: Upsert properties to a property definition # noqa: E501
|
1943
1943
|
|
1944
1944
|
Create or update properties for a particular property definition # noqa: E501
|
@@ -1954,7 +1954,7 @@ class PropertyDefinitionsApi:
|
|
1954
1954
|
:type scope: str
|
1955
1955
|
:param code: The code of the specified property. Together with the domain and scope this uniquely (required)
|
1956
1956
|
:type code: str
|
1957
|
-
:param request_body: The properties to be created or updated. Each property in
|
1957
|
+
:param request_body: The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'PropertyDefinition/Manager/Id'. (required)
|
1958
1958
|
:type request_body: Dict[str, ModelProperty]
|
1959
1959
|
:param success_mode: Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
|
1960
1960
|
:type success_mode: str
|