lusid-sdk 2.1.913__py3-none-any.whl → 2.1.914__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +139 -130
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_calendar_entry.py +21 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +1 -1
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_fund_bookmark_request.py +3 -3
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.914.dist-info}/WHEEL +0 -0
@@ -229,7 +229,7 @@ class IdentifierDefinitionsApi:
|
|
229
229
|
def delete_identifier_definition(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
230
230
|
"""[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition # noqa: E501
|
231
231
|
|
232
|
-
The deletion will take effect from the Identifier Definition deletion datetime.
|
232
|
+
The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
|
233
233
|
This method makes a synchronous HTTP request by default. To make an
|
234
234
|
asynchronous HTTP request, please pass async_req=True
|
235
235
|
|
@@ -264,7 +264,7 @@ class IdentifierDefinitionsApi:
|
|
264
264
|
def delete_identifier_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], **kwargs) -> ApiResponse: # noqa: E501
|
265
265
|
"""[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition # noqa: E501
|
266
266
|
|
267
|
-
The deletion will take effect from the Identifier Definition deletion datetime.
|
267
|
+
The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
|
268
268
|
This method makes a synchronous HTTP request by default. To make an
|
269
269
|
asynchronous HTTP request, please pass async_req=True
|
270
270
|
|
@@ -386,18 +386,18 @@ class IdentifierDefinitionsApi:
|
|
386
386
|
|
387
387
|
|
388
388
|
@overload
|
389
|
-
async def get_identifier_definition(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates.")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definition. Defaults to return
|
389
|
+
async def get_identifier_definition(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates.")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned.")] = None, **kwargs) -> IdentifierDefinition: # noqa: E501
|
390
390
|
...
|
391
391
|
|
392
392
|
@overload
|
393
|
-
def get_identifier_definition(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates.")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definition. Defaults to return
|
393
|
+
def get_identifier_definition(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates.")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=True, **kwargs) -> IdentifierDefinition: # noqa: E501
|
394
394
|
...
|
395
395
|
|
396
396
|
@validate_arguments
|
397
|
-
def get_identifier_definition(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates.")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definition. Defaults to return
|
397
|
+
def get_identifier_definition(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates.")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[IdentifierDefinition, Awaitable[IdentifierDefinition]]: # noqa: E501
|
398
398
|
"""[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition # noqa: E501
|
399
399
|
|
400
|
-
Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt
|
400
|
+
Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified # noqa: E501
|
401
401
|
This method makes a synchronous HTTP request by default. To make an
|
402
402
|
asynchronous HTTP request, please pass async_req=True
|
403
403
|
|
@@ -410,11 +410,11 @@ class IdentifierDefinitionsApi:
|
|
410
410
|
:type identifier_scope: str
|
411
411
|
:param identifier_type: What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition (required)
|
412
412
|
:type identifier_type: str
|
413
|
-
:param as_at: The asAt datetime at which to retrieve the Identifier Definition. Defaults to return
|
413
|
+
:param as_at: The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified.
|
414
414
|
:type as_at: datetime
|
415
|
-
:param effective_at: The effectiveAt datetime at which to retrieve the Identifier Definitions.
|
415
|
+
:param effective_at: The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.
|
416
416
|
:type effective_at: str
|
417
|
-
:param property_keys: A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition.
|
417
|
+
:param property_keys: A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned.
|
418
418
|
:type property_keys: List[str]
|
419
419
|
:param async_req: Whether to execute the request asynchronously.
|
420
420
|
:type async_req: bool, optional
|
@@ -435,10 +435,10 @@ class IdentifierDefinitionsApi:
|
|
435
435
|
return self.get_identifier_definition_with_http_info(domain, identifier_scope, identifier_type, as_at, effective_at, property_keys, **kwargs) # noqa: E501
|
436
436
|
|
437
437
|
@validate_arguments
|
438
|
-
def get_identifier_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates.")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definition. Defaults to return
|
438
|
+
def get_identifier_definition_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The type of entity to which the identifier relates.")], identifier_scope : Annotated[StrictStr, Field(..., description="The scope that the identifier exists in")], identifier_type : Annotated[StrictStr, Field(..., description="What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
439
439
|
"""[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition # noqa: E501
|
440
440
|
|
441
|
-
Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt
|
441
|
+
Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified # noqa: E501
|
442
442
|
This method makes a synchronous HTTP request by default. To make an
|
443
443
|
asynchronous HTTP request, please pass async_req=True
|
444
444
|
|
@@ -451,11 +451,11 @@ class IdentifierDefinitionsApi:
|
|
451
451
|
:type identifier_scope: str
|
452
452
|
:param identifier_type: What the identifier represents. Together with \"domain\" and \"identifierScope\" this uniquely identifies the identifier definition (required)
|
453
453
|
:type identifier_type: str
|
454
|
-
:param as_at: The asAt datetime at which to retrieve the Identifier Definition. Defaults to return
|
454
|
+
:param as_at: The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified.
|
455
455
|
:type as_at: datetime
|
456
|
-
:param effective_at: The effectiveAt datetime at which to retrieve the Identifier Definitions.
|
456
|
+
:param effective_at: The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.
|
457
457
|
:type effective_at: str
|
458
|
-
:param property_keys: A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition.
|
458
|
+
:param property_keys: A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned.
|
459
459
|
:type property_keys: List[str]
|
460
460
|
:param async_req: Whether to execute the request asynchronously.
|
461
461
|
:type async_req: bool, optional
|
@@ -582,37 +582,37 @@ class IdentifierDefinitionsApi:
|
|
582
582
|
|
583
583
|
|
584
584
|
@overload
|
585
|
-
async def list_identifier_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions.
|
585
|
+
async def list_identifier_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}.")] = None, **kwargs) -> PagedResourceListOfIdentifierDefinition: # noqa: E501
|
586
586
|
...
|
587
587
|
|
588
588
|
@overload
|
589
|
-
def list_identifier_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions.
|
589
|
+
def list_identifier_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfIdentifierDefinition: # noqa: E501
|
590
590
|
...
|
591
591
|
|
592
592
|
@validate_arguments
|
593
|
-
def list_identifier_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions.
|
593
|
+
def list_identifier_definitions(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfIdentifierDefinition, Awaitable[PagedResourceListOfIdentifierDefinition]]: # noqa: E501
|
594
594
|
"""[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions # noqa: E501
|
595
595
|
|
596
|
-
Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided
|
596
|
+
Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination # noqa: E501
|
597
597
|
This method makes a synchronous HTTP request by default. To make an
|
598
598
|
asynchronous HTTP request, please pass async_req=True
|
599
599
|
|
600
600
|
>>> thread = api.list_identifier_definitions(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
|
601
601
|
>>> result = thread.get()
|
602
602
|
|
603
|
-
:param effective_at: The effectiveAt datetime at which to retrieve the Identifier Definitions.
|
603
|
+
:param effective_at: The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.
|
604
604
|
:type effective_at: str
|
605
|
-
:param as_at: The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest
|
605
|
+
:param as_at: The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified.
|
606
606
|
:type as_at: datetime
|
607
|
-
:param page: The pagination token to use to continue listing Identifier Definitions from a previous call to list
|
607
|
+
:param page: The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
608
608
|
:type page: str
|
609
609
|
:param limit: When paginating, limit the number of returned results to this many per page.
|
610
610
|
:type limit: int
|
611
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
611
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
612
612
|
:type filter: str
|
613
613
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
614
614
|
:type sort_by: List[str]
|
615
|
-
:param property_keys: A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition.
|
615
|
+
:param property_keys: A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}.
|
616
616
|
:type property_keys: List[str]
|
617
617
|
:param async_req: Whether to execute the request asynchronously.
|
618
618
|
:type async_req: bool, optional
|
@@ -633,29 +633,29 @@ class IdentifierDefinitionsApi:
|
|
633
633
|
return self.list_identifier_definitions_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, **kwargs) # noqa: E501
|
634
634
|
|
635
635
|
@validate_arguments
|
636
|
-
def list_identifier_definitions_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions.
|
636
|
+
def list_identifier_definitions_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
637
637
|
"""[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions # noqa: E501
|
638
638
|
|
639
|
-
Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided
|
639
|
+
Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination # noqa: E501
|
640
640
|
This method makes a synchronous HTTP request by default. To make an
|
641
641
|
asynchronous HTTP request, please pass async_req=True
|
642
642
|
|
643
643
|
>>> thread = api.list_identifier_definitions_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
|
644
644
|
>>> result = thread.get()
|
645
645
|
|
646
|
-
:param effective_at: The effectiveAt datetime at which to retrieve the Identifier Definitions.
|
646
|
+
:param effective_at: The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.
|
647
647
|
:type effective_at: str
|
648
|
-
:param as_at: The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest
|
648
|
+
:param as_at: The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified.
|
649
649
|
:type as_at: datetime
|
650
|
-
:param page: The pagination token to use to continue listing Identifier Definitions from a previous call to list
|
650
|
+
:param page: The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
651
651
|
:type page: str
|
652
652
|
:param limit: When paginating, limit the number of returned results to this many per page.
|
653
653
|
:type limit: int
|
654
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
654
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
655
655
|
:type filter: str
|
656
656
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
657
657
|
:type sort_by: List[str]
|
658
|
-
:param property_keys: A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition.
|
658
|
+
:param property_keys: A list of property keys from the 'IdentifierDefinition' domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}.
|
659
659
|
:type property_keys: List[str]
|
660
660
|
:param async_req: Whether to execute the request asynchronously.
|
661
661
|
:type async_req: bool, optional
|