lusid-sdk 2.1.913__py3-none-any.whl → 2.1.915__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.915.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.915.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.913.dist-info → lusid_sdk-2.1.915.dist-info}/WHEEL +0 -0
@@ -77,7 +77,7 @@ class StructuredResultDataApi:
|
|
77
77
|
def create_data_map(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to create or update data maps.")], request_body : Annotated[Dict[str, CreateDataMapRequest], Field(..., description="Individual data map creation requests.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertStructuredDataResponse, Awaitable[UpsertStructuredDataResponse]]: # noqa: E501
|
78
78
|
"""CreateDataMap: Create data map # noqa: E501
|
79
79
|
|
80
|
-
Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created.
|
80
|
+
Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
81
81
|
This method makes a synchronous HTTP request by default. To make an
|
82
82
|
asynchronous HTTP request, please pass async_req=True
|
83
83
|
|
@@ -110,7 +110,7 @@ class StructuredResultDataApi:
|
|
110
110
|
def create_data_map_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to create or update data maps.")], request_body : Annotated[Dict[str, CreateDataMapRequest], Field(..., description="Individual data map creation requests.")], **kwargs) -> ApiResponse: # noqa: E501
|
111
111
|
"""CreateDataMap: Create data map # noqa: E501
|
112
112
|
|
113
|
-
Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created.
|
113
|
+
Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
114
114
|
This method makes a synchronous HTTP request by default. To make an
|
115
115
|
asynchronous HTTP request, please pass async_req=True
|
116
116
|
|
@@ -244,7 +244,7 @@ class StructuredResultDataApi:
|
|
244
244
|
def delete_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to delete data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The data IDs to delete, each keyed by a unique, ephemeral correlation ID.")], async_req: Optional[bool]=None, **kwargs) -> Union[AnnulStructuredDataResponse, Awaitable[AnnulStructuredDataResponse]]: # noqa: E501
|
245
245
|
"""DeleteStructuredResultData: Delete structured result data # noqa: E501
|
246
246
|
|
247
|
-
Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes
|
247
|
+
Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
248
248
|
This method makes a synchronous HTTP request by default. To make an
|
249
249
|
asynchronous HTTP request, please pass async_req=True
|
250
250
|
|
@@ -277,7 +277,7 @@ class StructuredResultDataApi:
|
|
277
277
|
def delete_structured_result_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to delete data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The data IDs to delete, each keyed by a unique, ephemeral correlation ID.")], **kwargs) -> ApiResponse: # noqa: E501
|
278
278
|
"""DeleteStructuredResultData: Delete structured result data # noqa: E501
|
279
279
|
|
280
|
-
Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes
|
280
|
+
Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
281
281
|
This method makes a synchronous HTTP request by default. To make an
|
282
282
|
asynchronous HTTP request, please pass async_req=True
|
283
283
|
|
@@ -400,15 +400,15 @@ class StructuredResultDataApi:
|
|
400
400
|
|
401
401
|
|
402
402
|
@overload
|
403
|
-
async def get_address_key_definitions_for_document(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved.
|
403
|
+
async def get_address_key_definitions_for_document(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, **kwargs) -> ResourceListOfAddressKeyDefinition: # noqa: E501
|
404
404
|
...
|
405
405
|
|
406
406
|
@overload
|
407
|
-
def get_address_key_definitions_for_document(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved.
|
407
|
+
def get_address_key_definitions_for_document(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfAddressKeyDefinition: # noqa: E501
|
408
408
|
...
|
409
409
|
|
410
410
|
@validate_arguments
|
411
|
-
def get_address_key_definitions_for_document(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved.
|
411
|
+
def get_address_key_definitions_for_document(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAddressKeyDefinition, Awaitable[ResourceListOfAddressKeyDefinition]]: # noqa: E501
|
412
412
|
"""GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. # noqa: E501
|
413
413
|
|
414
414
|
For a given virtual document retrieve all the address key definitions that are in use. # noqa: E501
|
@@ -426,9 +426,9 @@ class StructuredResultDataApi:
|
|
426
426
|
:type source: str
|
427
427
|
:param result_type: The result type of the document for which address key definitions are retrieved. (required)
|
428
428
|
:type result_type: str
|
429
|
-
:param effective_at: The effective datetime to query the document for which the address key definitions are retrieved.
|
429
|
+
:param effective_at: The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.
|
430
430
|
:type effective_at: str
|
431
|
-
:param as_at: The asAt datetime to query the document for which the address key definitions are retrieved.
|
431
|
+
:param as_at: The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.
|
432
432
|
:type as_at: datetime
|
433
433
|
:param async_req: Whether to execute the request asynchronously.
|
434
434
|
:type async_req: bool, optional
|
@@ -449,7 +449,7 @@ class StructuredResultDataApi:
|
|
449
449
|
return self.get_address_key_definitions_for_document_with_http_info(scope, code, source, result_type, effective_at, as_at, **kwargs) # noqa: E501
|
450
450
|
|
451
451
|
@validate_arguments
|
452
|
-
def get_address_key_definitions_for_document_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved.
|
452
|
+
def get_address_key_definitions_for_document_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
453
453
|
"""GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. # noqa: E501
|
454
454
|
|
455
455
|
For a given virtual document retrieve all the address key definitions that are in use. # noqa: E501
|
@@ -467,9 +467,9 @@ class StructuredResultDataApi:
|
|
467
467
|
:type source: str
|
468
468
|
:param result_type: The result type of the document for which address key definitions are retrieved. (required)
|
469
469
|
:type result_type: str
|
470
|
-
:param effective_at: The effective datetime to query the document for which the address key definitions are retrieved.
|
470
|
+
:param effective_at: The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.
|
471
471
|
:type effective_at: str
|
472
|
-
:param as_at: The asAt datetime to query the document for which the address key definitions are retrieved.
|
472
|
+
:param as_at: The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.
|
473
473
|
:type as_at: datetime
|
474
474
|
:param async_req: Whether to execute the request asynchronously.
|
475
475
|
:type async_req: bool, optional
|
@@ -606,7 +606,7 @@ class StructuredResultDataApi:
|
|
606
606
|
def get_data_map(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data maps.")], request_body : Annotated[Dict[str, DataMapKey], Field(..., description="The data map keys to look up, each keyed by a unique, ephemeral correlation ID.")], async_req: Optional[bool]=None, **kwargs) -> Union[GetDataMapResponse, Awaitable[GetDataMapResponse]]: # noqa: E501
|
607
607
|
"""GetDataMap: Get data map # noqa: E501
|
608
608
|
|
609
|
-
Retrieve one or more structured result store address definition data maps from a particular scope.
|
609
|
+
Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
610
610
|
This method makes a synchronous HTTP request by default. To make an
|
611
611
|
asynchronous HTTP request, please pass async_req=True
|
612
612
|
|
@@ -639,7 +639,7 @@ class StructuredResultDataApi:
|
|
639
639
|
def get_data_map_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data maps.")], request_body : Annotated[Dict[str, DataMapKey], Field(..., description="The data map keys to look up, each keyed by a unique, ephemeral correlation ID.")], **kwargs) -> ApiResponse: # noqa: E501
|
640
640
|
"""GetDataMap: Get data map # noqa: E501
|
641
641
|
|
642
|
-
Retrieve one or more structured result store address definition data maps from a particular scope.
|
642
|
+
Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
643
643
|
This method makes a synchronous HTTP request by default. To make an
|
644
644
|
asynchronous HTTP request, please pass async_req=True
|
645
645
|
|
@@ -762,18 +762,18 @@ class StructuredResultDataApi:
|
|
762
762
|
|
763
763
|
|
764
764
|
@overload
|
765
|
-
async def get_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes).
|
765
|
+
async def get_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved.")] = None, **kwargs) -> GetStructuredResultDataResponse: # noqa: E501
|
766
766
|
...
|
767
767
|
|
768
768
|
@overload
|
769
|
-
def get_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes).
|
769
|
+
def get_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved.")] = None, async_req: Optional[bool]=True, **kwargs) -> GetStructuredResultDataResponse: # noqa: E501
|
770
770
|
...
|
771
771
|
|
772
772
|
@validate_arguments
|
773
|
-
def get_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes).
|
773
|
+
def get_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetStructuredResultDataResponse, Awaitable[GetStructuredResultDataResponse]]: # noqa: E501
|
774
774
|
"""GetStructuredResultData: Get structured result data # noqa: E501
|
775
775
|
|
776
|
-
Retrieve one or more structured result data items from a particular scope.
|
776
|
+
Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
777
777
|
This method makes a synchronous HTTP request by default. To make an
|
778
778
|
asynchronous HTTP request, please pass async_req=True
|
779
779
|
|
@@ -786,7 +786,7 @@ class StructuredResultDataApi:
|
|
786
786
|
:type request_body: Dict[str, StructuredResultDataId]
|
787
787
|
:param as_at: The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.
|
788
788
|
:type as_at: datetime
|
789
|
-
:param max_age: The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes).
|
789
|
+
:param max_age: The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved.
|
790
790
|
:type max_age: str
|
791
791
|
:param async_req: Whether to execute the request asynchronously.
|
792
792
|
:type async_req: bool, optional
|
@@ -807,10 +807,10 @@ class StructuredResultDataApi:
|
|
807
807
|
return self.get_structured_result_data_with_http_info(scope, request_body, as_at, max_age, **kwargs) # noqa: E501
|
808
808
|
|
809
809
|
@validate_arguments
|
810
|
-
def get_structured_result_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes).
|
810
|
+
def get_structured_result_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
811
811
|
"""GetStructuredResultData: Get structured result data # noqa: E501
|
812
812
|
|
813
|
-
Retrieve one or more structured result data items from a particular scope.
|
813
|
+
Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
814
814
|
This method makes a synchronous HTTP request by default. To make an
|
815
815
|
asynchronous HTTP request, please pass async_req=True
|
816
816
|
|
@@ -823,7 +823,7 @@ class StructuredResultDataApi:
|
|
823
823
|
:type request_body: Dict[str, StructuredResultDataId]
|
824
824
|
:param as_at: The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.
|
825
825
|
:type as_at: datetime
|
826
|
-
:param max_age: The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes).
|
826
|
+
:param max_age: The duration of the look-back window in ISO8601 time interval format, for example 'P1Y2M3DT4H30M' (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved.
|
827
827
|
:type max_age: str
|
828
828
|
:param async_req: Whether to execute the request asynchronously.
|
829
829
|
:type async_req: bool, optional
|
@@ -959,7 +959,7 @@ class StructuredResultDataApi:
|
|
959
959
|
def get_virtual_document(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to construct the virtual documents.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetVirtualDocumentResponse, Awaitable[GetVirtualDocumentResponse]]: # noqa: E501
|
960
960
|
"""GetVirtualDocument: Get Virtual Documents # noqa: E501
|
961
961
|
|
962
|
-
Retrieve one or more virtual documents from a particular scope.
|
962
|
+
Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
963
963
|
This method makes a synchronous HTTP request by default. To make an
|
964
964
|
asynchronous HTTP request, please pass async_req=True
|
965
965
|
|
@@ -994,7 +994,7 @@ class StructuredResultDataApi:
|
|
994
994
|
def get_virtual_document_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to construct the virtual documents.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
995
995
|
"""GetVirtualDocument: Get Virtual Documents # noqa: E501
|
996
996
|
|
997
|
-
Retrieve one or more virtual documents from a particular scope.
|
997
|
+
Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
998
998
|
This method makes a synchronous HTTP request by default. To make an
|
999
999
|
asynchronous HTTP request, please pass async_req=True
|
1000
1000
|
|
@@ -1126,18 +1126,18 @@ class StructuredResultDataApi:
|
|
1126
1126
|
|
1127
1127
|
|
1128
1128
|
@overload
|
1129
|
-
async def get_virtual_document_rows(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous
|
1129
|
+
async def get_virtual_document_rows(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfVirtualRow: # noqa: E501
|
1130
1130
|
...
|
1131
1131
|
|
1132
1132
|
@overload
|
1133
|
-
def get_virtual_document_rows(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous
|
1133
|
+
def get_virtual_document_rows(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfVirtualRow: # noqa: E501
|
1134
1134
|
...
|
1135
1135
|
|
1136
1136
|
@validate_arguments
|
1137
|
-
def get_virtual_document_rows(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous
|
1137
|
+
def get_virtual_document_rows(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfVirtualRow, Awaitable[PagedResourceListOfVirtualRow]]: # noqa: E501
|
1138
1138
|
"""GetVirtualDocumentRows: Get Virtual Document Rows # noqa: E501
|
1139
1139
|
|
1140
|
-
Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time.
|
1140
|
+
Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. # noqa: E501
|
1141
1141
|
This method makes a synchronous HTTP request by default. To make an
|
1142
1142
|
asynchronous HTTP request, please pass async_req=True
|
1143
1143
|
|
@@ -1156,11 +1156,11 @@ class StructuredResultDataApi:
|
|
1156
1156
|
:type effective_at: str
|
1157
1157
|
:param as_at: The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.
|
1158
1158
|
:type as_at: datetime
|
1159
|
-
:param page: The pagination token to use to continue listing virtual document rows from a previous
|
1159
|
+
:param page: The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. 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.
|
1160
1160
|
:type page: str
|
1161
1161
|
:param limit: When paginating, limit the number of returned results to this many.
|
1162
1162
|
:type limit: int
|
1163
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
1163
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1164
1164
|
:type filter: str
|
1165
1165
|
:param async_req: Whether to execute the request asynchronously.
|
1166
1166
|
:type async_req: bool, optional
|
@@ -1181,10 +1181,10 @@ class StructuredResultDataApi:
|
|
1181
1181
|
return self.get_virtual_document_rows_with_http_info(scope, code, source, result_type, effective_at, as_at, page, limit, filter, **kwargs) # noqa: E501
|
1182
1182
|
|
1183
1183
|
@validate_arguments
|
1184
|
-
def get_virtual_document_rows_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous
|
1184
|
+
def get_virtual_document_rows_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1185
1185
|
"""GetVirtualDocumentRows: Get Virtual Document Rows # noqa: E501
|
1186
1186
|
|
1187
|
-
Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time.
|
1187
|
+
Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. # noqa: E501
|
1188
1188
|
This method makes a synchronous HTTP request by default. To make an
|
1189
1189
|
asynchronous HTTP request, please pass async_req=True
|
1190
1190
|
|
@@ -1203,11 +1203,11 @@ class StructuredResultDataApi:
|
|
1203
1203
|
:type effective_at: str
|
1204
1204
|
:param as_at: The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.
|
1205
1205
|
:type as_at: datetime
|
1206
|
-
:param page: The pagination token to use to continue listing virtual document rows from a previous
|
1206
|
+
:param page: The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. 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.
|
1207
1207
|
:type page: str
|
1208
1208
|
:param limit: When paginating, limit the number of returned results to this many.
|
1209
1209
|
:type limit: int
|
1210
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
1210
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1211
1211
|
:type filter: str
|
1212
1212
|
:param async_req: Whether to execute the request asynchronously.
|
1213
1213
|
:type async_req: bool, optional
|
@@ -1356,7 +1356,7 @@ class StructuredResultDataApi:
|
|
1356
1356
|
def upsert_result_value(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to construct the virtual documents.")], request_body : Annotated[Dict[str, UpsertResultValuesDataRequest], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertStructuredDataResponse, Awaitable[UpsertStructuredDataResponse]]: # noqa: E501
|
1357
1357
|
"""UpsertResultValue: Upsert result value # noqa: E501
|
1358
1358
|
|
1359
|
-
Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists
|
1359
|
+
Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
1360
1360
|
This method makes a synchronous HTTP request by default. To make an
|
1361
1361
|
asynchronous HTTP request, please pass async_req=True
|
1362
1362
|
|
@@ -1389,7 +1389,7 @@ class StructuredResultDataApi:
|
|
1389
1389
|
def upsert_result_value_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to construct the virtual documents.")], request_body : Annotated[Dict[str, UpsertResultValuesDataRequest], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], **kwargs) -> ApiResponse: # noqa: E501
|
1390
1390
|
"""UpsertResultValue: Upsert result value # noqa: E501
|
1391
1391
|
|
1392
|
-
Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists
|
1392
|
+
Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
1393
1393
|
This method makes a synchronous HTTP request by default. To make an
|
1394
1394
|
asynchronous HTTP request, please pass async_req=True
|
1395
1395
|
|
@@ -1523,7 +1523,7 @@ class StructuredResultDataApi:
|
|
1523
1523
|
def upsert_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to create or update data items.")], request_body : Annotated[Dict[str, UpsertStructuredResultDataRequest], Field(..., description="The set of data items to create or update, keyed by a unique, ephemeral correlation ID.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertStructuredDataResponse, Awaitable[UpsertStructuredDataResponse]]: # noqa: E501
|
1524
1524
|
"""UpsertStructuredResultData: Upsert structured result data # noqa: E501
|
1525
1525
|
|
1526
|
-
Create or update one or more structured result data items in a particular scope. An item is updated if it already exists
|
1526
|
+
Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
1527
1527
|
This method makes a synchronous HTTP request by default. To make an
|
1528
1528
|
asynchronous HTTP request, please pass async_req=True
|
1529
1529
|
|
@@ -1556,7 +1556,7 @@ class StructuredResultDataApi:
|
|
1556
1556
|
def upsert_structured_result_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to create or update data items.")], request_body : Annotated[Dict[str, UpsertStructuredResultDataRequest], Field(..., description="The set of data items to create or update, keyed by a unique, ephemeral correlation ID.")], **kwargs) -> ApiResponse: # noqa: E501
|
1557
1557
|
"""UpsertStructuredResultData: Upsert structured result data # noqa: E501
|
1558
1558
|
|
1559
|
-
Create or update one or more structured result data items in a particular scope. An item is updated if it already exists
|
1559
|
+
Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
1560
1560
|
This method makes a synchronous HTTP request by default. To make an
|
1561
1561
|
asynchronous HTTP request, please pass async_req=True
|
1562
1562
|
|
@@ -389,7 +389,7 @@ class SystemConfigurationApi:
|
|
389
389
|
def delete_transaction_configuration_source(self, source : Annotated[StrictStr, Field(..., description="The source to delete transaction configurations for")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
390
390
|
"""[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source # noqa: E501
|
391
391
|
|
392
|
-
/// WARNING! Changing existing transaction types has a material impact on how data, new and old,
|
392
|
+
/// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
393
393
|
This method makes a synchronous HTTP request by default. To make an
|
394
394
|
asynchronous HTTP request, please pass async_req=True
|
395
395
|
|
@@ -420,7 +420,7 @@ class SystemConfigurationApi:
|
|
420
420
|
def delete_transaction_configuration_source_with_http_info(self, source : Annotated[StrictStr, Field(..., description="The source to delete transaction configurations for")], **kwargs) -> ApiResponse: # noqa: E501
|
421
421
|
"""[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source # noqa: E501
|
422
422
|
|
423
|
-
/// WARNING! Changing existing transaction types has a material impact on how data, new and old,
|
423
|
+
/// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
424
424
|
This method makes a synchronous HTTP request by default. To make an
|
425
425
|
asynchronous HTTP request, please pass async_req=True
|
426
426
|
|
@@ -530,15 +530,15 @@ class SystemConfigurationApi:
|
|
530
530
|
|
531
531
|
|
532
532
|
@overload
|
533
|
-
async def get_transaction_configuration_source(self, source : Annotated[StrictStr, Field(..., description="The source for which to retrieve transaction configurations")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configurations.
|
533
|
+
async def get_transaction_configuration_source(self, source : Annotated[StrictStr, Field(..., description="The source for which to retrieve transaction configurations")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified.")] = None, **kwargs) -> TransactionSetConfigurationData: # noqa: E501
|
534
534
|
...
|
535
535
|
|
536
536
|
@overload
|
537
|
-
def get_transaction_configuration_source(self, source : Annotated[StrictStr, Field(..., description="The source for which to retrieve transaction configurations")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configurations.
|
537
|
+
def get_transaction_configuration_source(self, source : Annotated[StrictStr, Field(..., description="The source for which to retrieve transaction configurations")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> TransactionSetConfigurationData: # noqa: E501
|
538
538
|
...
|
539
539
|
|
540
540
|
@validate_arguments
|
541
|
-
def get_transaction_configuration_source(self, source : Annotated[StrictStr, Field(..., description="The source for which to retrieve transaction configurations")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configurations.
|
541
|
+
def get_transaction_configuration_source(self, source : Annotated[StrictStr, Field(..., description="The source for which to retrieve transaction configurations")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TransactionSetConfigurationData, Awaitable[TransactionSetConfigurationData]]: # noqa: E501
|
542
542
|
"""[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source # noqa: E501
|
543
543
|
|
544
544
|
Returns failure if requested source is not found # noqa: E501
|
@@ -550,7 +550,7 @@ class SystemConfigurationApi:
|
|
550
550
|
|
551
551
|
:param source: The source for which to retrieve transaction configurations (required)
|
552
552
|
:type source: str
|
553
|
-
:param as_at: The asAt datetime at which to retrieve the transaction configurations.
|
553
|
+
:param as_at: The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified.
|
554
554
|
:type as_at: datetime
|
555
555
|
:param async_req: Whether to execute the request asynchronously.
|
556
556
|
:type async_req: bool, optional
|
@@ -571,7 +571,7 @@ class SystemConfigurationApi:
|
|
571
571
|
return self.get_transaction_configuration_source_with_http_info(source, as_at, **kwargs) # noqa: E501
|
572
572
|
|
573
573
|
@validate_arguments
|
574
|
-
def get_transaction_configuration_source_with_http_info(self, source : Annotated[StrictStr, Field(..., description="The source for which to retrieve transaction configurations")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configurations.
|
574
|
+
def get_transaction_configuration_source_with_http_info(self, source : Annotated[StrictStr, Field(..., description="The source for which to retrieve transaction configurations")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
575
575
|
"""[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source # noqa: E501
|
576
576
|
|
577
577
|
Returns failure if requested source is not found # noqa: E501
|
@@ -583,7 +583,7 @@ class SystemConfigurationApi:
|
|
583
583
|
|
584
584
|
:param source: The source for which to retrieve transaction configurations (required)
|
585
585
|
:type source: str
|
586
|
-
:param as_at: The asAt datetime at which to retrieve the transaction configurations.
|
586
|
+
:param as_at: The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified.
|
587
587
|
:type as_at: datetime
|
588
588
|
:param async_req: Whether to execute the request asynchronously.
|
589
589
|
:type async_req: bool, optional
|
@@ -693,25 +693,25 @@ class SystemConfigurationApi:
|
|
693
693
|
|
694
694
|
|
695
695
|
@overload
|
696
|
-
async def list_configuration_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults
|
696
|
+
async def list_configuration_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.")] = None, **kwargs) -> TransactionSetConfigurationData: # noqa: E501
|
697
697
|
...
|
698
698
|
|
699
699
|
@overload
|
700
|
-
def list_configuration_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults
|
700
|
+
def list_configuration_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> TransactionSetConfigurationData: # noqa: E501
|
701
701
|
...
|
702
702
|
|
703
703
|
@validate_arguments
|
704
|
-
def list_configuration_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults
|
704
|
+
def list_configuration_transaction_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TransactionSetConfigurationData, Awaitable[TransactionSetConfigurationData]]: # noqa: E501
|
705
705
|
"""[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types # noqa: E501
|
706
706
|
|
707
|
-
Get the list of current transaction types. For information on the default transaction types provided with
|
707
|
+
Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/. # noqa: E501
|
708
708
|
This method makes a synchronous HTTP request by default. To make an
|
709
709
|
asynchronous HTTP request, please pass async_req=True
|
710
710
|
|
711
711
|
>>> thread = api.list_configuration_transaction_types(as_at, async_req=True)
|
712
712
|
>>> result = thread.get()
|
713
713
|
|
714
|
-
:param as_at: The asAt datetime at which to retrieve the transaction types. Defaults
|
714
|
+
:param as_at: The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.
|
715
715
|
:type as_at: datetime
|
716
716
|
:param async_req: Whether to execute the request asynchronously.
|
717
717
|
:type async_req: bool, optional
|
@@ -732,17 +732,17 @@ class SystemConfigurationApi:
|
|
732
732
|
return self.list_configuration_transaction_types_with_http_info(as_at, **kwargs) # noqa: E501
|
733
733
|
|
734
734
|
@validate_arguments
|
735
|
-
def list_configuration_transaction_types_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults
|
735
|
+
def list_configuration_transaction_types_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
736
736
|
"""[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types # noqa: E501
|
737
737
|
|
738
|
-
Get the list of current transaction types. For information on the default transaction types provided with
|
738
|
+
Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/. # noqa: E501
|
739
739
|
This method makes a synchronous HTTP request by default. To make an
|
740
740
|
asynchronous HTTP request, please pass async_req=True
|
741
741
|
|
742
742
|
>>> thread = api.list_configuration_transaction_types_with_http_info(as_at, async_req=True)
|
743
743
|
>>> result = thread.get()
|
744
744
|
|
745
|
-
:param as_at: The asAt datetime at which to retrieve the transaction types. Defaults
|
745
|
+
:param as_at: The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.
|
746
746
|
:type as_at: datetime
|
747
747
|
:param async_req: Whether to execute the request asynchronously.
|
748
748
|
:type async_req: bool, optional
|
@@ -859,7 +859,7 @@ class SystemConfigurationApi:
|
|
859
859
|
def set_configuration_transaction_types(self, transaction_set_configuration_data_request : Annotated[Optional[TransactionSetConfigurationDataRequest], Field(description="The complete set of transaction type definitions.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TransactionSetConfigurationData, Awaitable[TransactionSetConfigurationData]]: # noqa: E501
|
860
860
|
"""[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types # noqa: E501
|
861
861
|
|
862
|
-
Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own.
|
862
|
+
Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
863
863
|
This method makes a synchronous HTTP request by default. To make an
|
864
864
|
asynchronous HTTP request, please pass async_req=True
|
865
865
|
|
@@ -890,7 +890,7 @@ class SystemConfigurationApi:
|
|
890
890
|
def set_configuration_transaction_types_with_http_info(self, transaction_set_configuration_data_request : Annotated[Optional[TransactionSetConfigurationDataRequest], Field(description="The complete set of transaction type definitions.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
891
891
|
"""[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types # noqa: E501
|
892
892
|
|
893
|
-
Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own.
|
893
|
+
Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
894
894
|
This method makes a synchronous HTTP request by default. To make an
|
895
895
|
asynchronous HTTP request, please pass async_req=True
|
896
896
|
|
@@ -1018,7 +1018,7 @@ class SystemConfigurationApi:
|
|
1018
1018
|
def set_transaction_configuration_source(self, source : Annotated[StrictStr, Field(..., description="The source to set the transaction configurations for")], set_transaction_configuration_source_request : Annotated[conlist(SetTransactionConfigurationSourceRequest), Field(..., description="The set of transaction configurations")], async_req: Optional[bool]=None, **kwargs) -> Union[TransactionSetConfigurationData, Awaitable[TransactionSetConfigurationData]]: # noqa: E501
|
1019
1019
|
"""[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source # noqa: E501
|
1020
1020
|
|
1021
|
-
This will replace all the existing transaction configurations for the given source
|
1021
|
+
This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
1022
1022
|
This method makes a synchronous HTTP request by default. To make an
|
1023
1023
|
asynchronous HTTP request, please pass async_req=True
|
1024
1024
|
|
@@ -1051,7 +1051,7 @@ class SystemConfigurationApi:
|
|
1051
1051
|
def set_transaction_configuration_source_with_http_info(self, source : Annotated[StrictStr, Field(..., description="The source to set the transaction configurations for")], set_transaction_configuration_source_request : Annotated[conlist(SetTransactionConfigurationSourceRequest), Field(..., description="The set of transaction configurations")], **kwargs) -> ApiResponse: # noqa: E501
|
1052
1052
|
"""[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source # noqa: E501
|
1053
1053
|
|
1054
|
-
This will replace all the existing transaction configurations for the given source
|
1054
|
+
This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. # noqa: E501
|
1055
1055
|
This method makes a synchronous HTTP request by default. To make an
|
1056
1056
|
asynchronous HTTP request, please pass async_req=True
|
1057
1057
|
|