lusid-sdk 2.1.911__py3-none-any.whl → 2.1.912__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +126 -126
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_holding.py +6 -2
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +6 -4
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/settlement_schedule.py +20 -2
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.912.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.912.dist-info}/RECORD +332 -332
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.912.dist-info}/WHEEL +0 -0
@@ -380,15 +380,15 @@ class CustomEntityDefinitionsApi:
|
|
380
380
|
|
381
381
|
|
382
382
|
@overload
|
383
|
-
async def list_custom_entity_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version
|
383
|
+
async def list_custom_entity_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.")] = None, **kwargs) -> PagedResourceListOfCustomEntityDefinition: # noqa: E501
|
384
384
|
...
|
385
385
|
|
386
386
|
@overload
|
387
|
-
def list_custom_entity_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version
|
387
|
+
def list_custom_entity_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCustomEntityDefinition: # noqa: E501
|
388
388
|
...
|
389
389
|
|
390
390
|
@validate_arguments
|
391
|
-
def list_custom_entity_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version
|
391
|
+
def list_custom_entity_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCustomEntityDefinition, Awaitable[PagedResourceListOfCustomEntityDefinition]]: # noqa: E501
|
392
392
|
"""[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions # noqa: E501
|
393
393
|
|
394
394
|
List all Custom Entity type definitions matching particular criteria. # noqa: E501
|
@@ -398,13 +398,13 @@ class CustomEntityDefinitionsApi:
|
|
398
398
|
>>> thread = api.list_custom_entity_definitions(as_at, limit, filter, page, async_req=True)
|
399
399
|
>>> result = thread.get()
|
400
400
|
|
401
|
-
:param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version
|
401
|
+
:param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
|
402
402
|
:type as_at: datetime
|
403
403
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
404
404
|
:type limit: int
|
405
|
-
:param filter: Expression to filter the results. For more information about filtering
|
405
|
+
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
406
406
|
:type filter: str
|
407
|
-
:param page: The pagination token to use to continue listing entities; this
|
407
|
+
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.
|
408
408
|
:type page: str
|
409
409
|
:param async_req: Whether to execute the request asynchronously.
|
410
410
|
:type async_req: bool, optional
|
@@ -425,7 +425,7 @@ class CustomEntityDefinitionsApi:
|
|
425
425
|
return self.list_custom_entity_definitions_with_http_info(as_at, limit, filter, page, **kwargs) # noqa: E501
|
426
426
|
|
427
427
|
@validate_arguments
|
428
|
-
def list_custom_entity_definitions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version
|
428
|
+
def list_custom_entity_definitions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
429
429
|
"""[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions # noqa: E501
|
430
430
|
|
431
431
|
List all Custom Entity type definitions matching particular criteria. # noqa: E501
|
@@ -435,13 +435,13 @@ class CustomEntityDefinitionsApi:
|
|
435
435
|
>>> thread = api.list_custom_entity_definitions_with_http_info(as_at, limit, filter, page, async_req=True)
|
436
436
|
>>> result = thread.get()
|
437
437
|
|
438
|
-
:param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version
|
438
|
+
:param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
|
439
439
|
:type as_at: datetime
|
440
440
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
441
441
|
:type limit: int
|
442
|
-
:param filter: Expression to filter the results. For more information about filtering
|
442
|
+
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
443
443
|
:type filter: str
|
444
|
-
:param page: The pagination token to use to continue listing entities; this
|
444
|
+
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.
|
445
445
|
:type page: str
|
446
446
|
:param async_req: Whether to execute the request asynchronously.
|
447
447
|
:type async_req: bool, optional
|
@@ -380,15 +380,15 @@ class CustomEntityTypesApi:
|
|
380
380
|
|
381
381
|
|
382
382
|
@overload
|
383
|
-
async def list_custom_entity_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version
|
383
|
+
async def list_custom_entity_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit, sortBy, and asAt fields must not have changed since the original request.")] = None, **kwargs) -> PagedResourceListOfCustomEntityType: # noqa: E501
|
384
384
|
...
|
385
385
|
|
386
386
|
@overload
|
387
|
-
def list_custom_entity_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version
|
387
|
+
def list_custom_entity_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit, sortBy, and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCustomEntityType: # noqa: E501
|
388
388
|
...
|
389
389
|
|
390
390
|
@validate_arguments
|
391
|
-
def list_custom_entity_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version
|
391
|
+
def list_custom_entity_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit, sortBy, and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCustomEntityType, Awaitable[PagedResourceListOfCustomEntityType]]: # noqa: E501
|
392
392
|
"""[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. # noqa: E501
|
393
393
|
|
394
394
|
List all Custom Entity Types matching particular criteria. # noqa: E501
|
@@ -398,15 +398,15 @@ class CustomEntityTypesApi:
|
|
398
398
|
>>> thread = api.list_custom_entity_types(as_at, limit, filter, sort_by, page, async_req=True)
|
399
399
|
>>> result = thread.get()
|
400
400
|
|
401
|
-
:param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version
|
401
|
+
:param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type if not specified.
|
402
402
|
:type as_at: datetime
|
403
403
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
404
404
|
:type limit: int
|
405
|
-
:param filter: Expression to filter the results. For more information about filtering
|
405
|
+
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
406
406
|
:type filter: str
|
407
407
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
408
408
|
:type sort_by: List[str]
|
409
|
-
:param page: The pagination token to use to continue listing entities; this
|
409
|
+
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit, sortBy, and asAt fields must not have changed since the original request.
|
410
410
|
:type page: str
|
411
411
|
:param async_req: Whether to execute the request asynchronously.
|
412
412
|
:type async_req: bool, optional
|
@@ -427,7 +427,7 @@ class CustomEntityTypesApi:
|
|
427
427
|
return self.list_custom_entity_types_with_http_info(as_at, limit, filter, sort_by, page, **kwargs) # noqa: E501
|
428
428
|
|
429
429
|
@validate_arguments
|
430
|
-
def list_custom_entity_types_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version
|
430
|
+
def list_custom_entity_types_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit, sortBy, and asAt fields must not have changed since the original request.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
431
431
|
"""[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. # noqa: E501
|
432
432
|
|
433
433
|
List all Custom Entity Types matching particular criteria. # noqa: E501
|
@@ -437,15 +437,15 @@ class CustomEntityTypesApi:
|
|
437
437
|
>>> thread = api.list_custom_entity_types_with_http_info(as_at, limit, filter, sort_by, page, async_req=True)
|
438
438
|
>>> result = thread.get()
|
439
439
|
|
440
|
-
:param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version
|
440
|
+
:param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type if not specified.
|
441
441
|
:type as_at: datetime
|
442
442
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
443
443
|
:type limit: int
|
444
|
-
:param filter: Expression to filter the results. For more information about filtering
|
444
|
+
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
445
445
|
:type filter: str
|
446
446
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
447
447
|
:type sort_by: List[str]
|
448
|
-
:param page: The pagination token to use to continue listing entities; this
|
448
|
+
:param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit, sortBy, and asAt fields must not have changed since the original request.
|
449
449
|
:type page: str
|
450
450
|
:param async_req: Whether to execute the request asynchronously.
|
451
451
|
:type async_req: bool, optional
|
@@ -532,15 +532,15 @@ class CutLabelDefinitionsApi:
|
|
532
532
|
|
533
533
|
|
534
534
|
@overload
|
535
|
-
async def list_cut_label_definitions(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The As At time at which listed Cut Labels are valid")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
535
|
+
async def list_cut_label_definitions(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The As At time at which listed Cut Labels are valid")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on code, use \"code eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, **kwargs) -> PagedResourceListOfCutLabelDefinition: # noqa: E501
|
536
536
|
...
|
537
537
|
|
538
538
|
@overload
|
539
|
-
def list_cut_label_definitions(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The As At time at which listed Cut Labels are valid")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
539
|
+
def list_cut_label_definitions(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The As At time at which listed Cut Labels are valid")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on code, use \"code eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCutLabelDefinition: # noqa: E501
|
540
540
|
...
|
541
541
|
|
542
542
|
@validate_arguments
|
543
|
-
def list_cut_label_definitions(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The As At time at which listed Cut Labels are valid")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
543
|
+
def list_cut_label_definitions(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The As At time at which listed Cut Labels are valid")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on code, use \"code eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCutLabelDefinition, Awaitable[PagedResourceListOfCutLabelDefinition]]: # noqa: E501
|
544
544
|
"""ListCutLabelDefinitions: List Existing Cut Labels # noqa: E501
|
545
545
|
|
546
546
|
List all the Cut Label Definitions that are valid at the given AsAt time # noqa: E501
|
@@ -556,9 +556,9 @@ class CutLabelDefinitionsApi:
|
|
556
556
|
:type sort_by: List[str]
|
557
557
|
:param limit: Optional. When paginating, limit the number of returned results to this many.
|
558
558
|
:type limit: int
|
559
|
-
:param filter: Optional. Expression to filter the result set.
|
559
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on code, use \"code eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
560
560
|
:type filter: str
|
561
|
-
:param page: The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call.
|
561
|
+
:param page: The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
|
562
562
|
:type page: str
|
563
563
|
:param async_req: Whether to execute the request asynchronously.
|
564
564
|
:type async_req: bool, optional
|
@@ -579,7 +579,7 @@ class CutLabelDefinitionsApi:
|
|
579
579
|
return self.list_cut_label_definitions_with_http_info(as_at, sort_by, limit, filter, page, **kwargs) # noqa: E501
|
580
580
|
|
581
581
|
@validate_arguments
|
582
|
-
def list_cut_label_definitions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The As At time at which listed Cut Labels are valid")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
582
|
+
def list_cut_label_definitions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="Optional. The As At time at which listed Cut Labels are valid")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on code, use \"code eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
583
583
|
"""ListCutLabelDefinitions: List Existing Cut Labels # noqa: E501
|
584
584
|
|
585
585
|
List all the Cut Label Definitions that are valid at the given AsAt time # noqa: E501
|
@@ -595,9 +595,9 @@ class CutLabelDefinitionsApi:
|
|
595
595
|
:type sort_by: List[str]
|
596
596
|
:param limit: Optional. When paginating, limit the number of returned results to this many.
|
597
597
|
:type limit: int
|
598
|
-
:param filter: Optional. Expression to filter the result set.
|
598
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on code, use \"code eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
599
599
|
:type filter: str
|
600
|
-
:param page: The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call.
|
600
|
+
:param page: The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
|
601
601
|
:type page: str
|
602
602
|
:param async_req: Whether to execute the request asynchronously.
|
603
603
|
:type async_req: bool, optional
|
lusid/api/data_types_api.py
CHANGED
@@ -74,7 +74,7 @@ class DataTypesApi:
|
|
74
74
|
def create_data_type(self, create_data_type_request : Annotated[Optional[CreateDataTypeRequest], Field(description="The definition of the new data type")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DataType, Awaitable[DataType]]: # noqa: E501
|
75
75
|
"""[EARLY ACCESS] CreateDataType: Create data type definition # noqa: E501
|
76
76
|
|
77
|
-
Create a new data type definition
|
77
|
+
Create a new data type definition Data types cannot be created in either the \"default\" or \"system\" scopes. # noqa: E501
|
78
78
|
This method makes a synchronous HTTP request by default. To make an
|
79
79
|
asynchronous HTTP request, please pass async_req=True
|
80
80
|
|
@@ -105,7 +105,7 @@ class DataTypesApi:
|
|
105
105
|
def create_data_type_with_http_info(self, create_data_type_request : Annotated[Optional[CreateDataTypeRequest], Field(description="The definition of the new data type")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
106
106
|
"""[EARLY ACCESS] CreateDataType: Create data type definition # noqa: E501
|
107
107
|
|
108
|
-
Create a new data type definition
|
108
|
+
Create a new data type definition Data types cannot be created in either the \"default\" or \"system\" scopes. # noqa: E501
|
109
109
|
This method makes a synchronous HTTP request by default. To make an
|
110
110
|
asynchronous HTTP request, please pass async_req=True
|
111
111
|
|
@@ -233,7 +233,7 @@ class DataTypesApi:
|
|
233
233
|
def delete_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
234
234
|
"""DeleteDataType: Delete a data type definition. # noqa: E501
|
235
235
|
|
236
|
-
Delete an existing data type definition.
|
236
|
+
Delete an existing data type definition. Data types cannot be deleted in either the \"default\" or \"system\" scopes, scopes beginning with \"LUSID-\", or data types that are in use on a property definition. # noqa: E501
|
237
237
|
This method makes a synchronous HTTP request by default. To make an
|
238
238
|
asynchronous HTTP request, please pass async_req=True
|
239
239
|
|
@@ -266,7 +266,7 @@ class DataTypesApi:
|
|
266
266
|
def delete_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], **kwargs) -> ApiResponse: # noqa: E501
|
267
267
|
"""DeleteDataType: Delete a data type definition. # noqa: E501
|
268
268
|
|
269
|
-
Delete an existing data type definition.
|
269
|
+
Delete an existing data type definition. Data types cannot be deleted in either the \"default\" or \"system\" scopes, scopes beginning with \"LUSID-\", or data types that are in use on a property definition. # noqa: E501
|
270
270
|
This method makes a synchronous HTTP request by default. To make an
|
271
271
|
asynchronous HTTP request, please pass async_req=True
|
272
272
|
|
@@ -382,15 +382,15 @@ class DataTypesApi:
|
|
382
382
|
|
383
383
|
|
384
384
|
@overload
|
385
|
-
async def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to
|
385
|
+
async def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.")] = None, **kwargs) -> DataType: # noqa: E501
|
386
386
|
...
|
387
387
|
|
388
388
|
@overload
|
389
|
-
def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to
|
389
|
+
def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> DataType: # noqa: E501
|
390
390
|
...
|
391
391
|
|
392
392
|
@validate_arguments
|
393
|
-
def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to
|
393
|
+
def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DataType, Awaitable[DataType]]: # noqa: E501
|
394
394
|
"""GetDataType: Get data type definition # noqa: E501
|
395
395
|
|
396
396
|
Get the definition of a specified data type # noqa: E501
|
@@ -404,7 +404,7 @@ class DataTypesApi:
|
|
404
404
|
:type scope: str
|
405
405
|
:param code: The code of the data type (required)
|
406
406
|
:type code: str
|
407
|
-
:param as_at: The asAt datetime at which to retrieve the data type definition. Defaults to
|
407
|
+
:param as_at: The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.
|
408
408
|
:type as_at: datetime
|
409
409
|
:param async_req: Whether to execute the request asynchronously.
|
410
410
|
:type async_req: bool, optional
|
@@ -425,7 +425,7 @@ class DataTypesApi:
|
|
425
425
|
return self.get_data_type_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
426
426
|
|
427
427
|
@validate_arguments
|
428
|
-
def get_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to
|
428
|
+
def get_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
429
429
|
"""GetDataType: Get data type definition # noqa: E501
|
430
430
|
|
431
431
|
Get the definition of a specified data type # noqa: E501
|
@@ -439,7 +439,7 @@ class DataTypesApi:
|
|
439
439
|
:type scope: str
|
440
440
|
:param code: The code of the data type (required)
|
441
441
|
:type code: str
|
442
|
-
:param as_at: The asAt datetime at which to retrieve the data type definition. Defaults to
|
442
|
+
:param as_at: The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.
|
443
443
|
:type as_at: datetime
|
444
444
|
:param async_req: Whether to execute the request asynchronously.
|
445
445
|
:type async_req: bool, optional
|
@@ -553,15 +553,15 @@ class DataTypesApi:
|
|
553
553
|
|
554
554
|
|
555
555
|
@overload
|
556
|
-
async def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
556
|
+
async def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, **kwargs) -> ResourceListOfIUnitDefinitionDto: # noqa: E501
|
557
557
|
...
|
558
558
|
|
559
559
|
@overload
|
560
|
-
def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
560
|
+
def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfIUnitDefinitionDto: # noqa: E501
|
561
561
|
...
|
562
562
|
|
563
563
|
@validate_arguments
|
564
|
-
def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
564
|
+
def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfIUnitDefinitionDto, Awaitable[ResourceListOfIUnitDefinitionDto]]: # noqa: E501
|
565
565
|
"""[EARLY ACCESS] GetUnitsFromDataType: Get units from data type # noqa: E501
|
566
566
|
|
567
567
|
Get the definitions of the specified units associated bound to a specific data type # noqa: E501
|
@@ -577,7 +577,7 @@ class DataTypesApi:
|
|
577
577
|
:type code: str
|
578
578
|
:param units: One or more unit identifiers for which the definition is being requested
|
579
579
|
:type units: List[str]
|
580
|
-
:param filter: Optional. Expression to filter the result set.
|
580
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
581
581
|
:type filter: str
|
582
582
|
:param as_at: Optional. The as at of the requested data type
|
583
583
|
:type as_at: datetime
|
@@ -600,7 +600,7 @@ class DataTypesApi:
|
|
600
600
|
return self.get_units_from_data_type_with_http_info(scope, code, units, filter, as_at, **kwargs) # noqa: E501
|
601
601
|
|
602
602
|
@validate_arguments
|
603
|
-
def get_units_from_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
603
|
+
def get_units_from_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
604
604
|
"""[EARLY ACCESS] GetUnitsFromDataType: Get units from data type # noqa: E501
|
605
605
|
|
606
606
|
Get the definitions of the specified units associated bound to a specific data type # noqa: E501
|
@@ -616,7 +616,7 @@ class DataTypesApi:
|
|
616
616
|
:type code: str
|
617
617
|
:param units: One or more unit identifiers for which the definition is being requested
|
618
618
|
:type units: List[str]
|
619
|
-
:param filter: Optional. Expression to filter the result set.
|
619
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
620
620
|
:type filter: str
|
621
621
|
:param as_at: Optional. The as at of the requested data type
|
622
622
|
:type as_at: datetime
|
@@ -741,15 +741,15 @@ class DataTypesApi:
|
|
741
741
|
|
742
742
|
|
743
743
|
@overload
|
744
|
-
async def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version
|
744
|
+
async def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" 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, **kwargs) -> PagedResourceListOfDataTypeSummary: # noqa: E501
|
745
745
|
...
|
746
746
|
|
747
747
|
@overload
|
748
|
-
def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version
|
748
|
+
def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" 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, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfDataTypeSummary: # noqa: E501
|
749
749
|
...
|
750
750
|
|
751
751
|
@validate_arguments
|
752
|
-
def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version
|
752
|
+
def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" 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, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfDataTypeSummary, Awaitable[PagedResourceListOfDataTypeSummary]]: # noqa: E501
|
753
753
|
"""[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data # noqa: E501
|
754
754
|
|
755
755
|
List all data type summaries # noqa: E501
|
@@ -759,13 +759,13 @@ class DataTypesApi:
|
|
759
759
|
>>> thread = api.list_data_type_summaries(as_at, page, limit, filter, sort_by, async_req=True)
|
760
760
|
>>> result = thread.get()
|
761
761
|
|
762
|
-
:param as_at: The asAt datetime at which to list the data type summaries. Defaults to returning the latest version
|
762
|
+
:param as_at: The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.
|
763
763
|
:type as_at: datetime
|
764
|
-
:param page: The pagination token to use to continue listing data type summaries. This
|
764
|
+
:param page: The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.
|
765
765
|
:type page: str
|
766
766
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
767
767
|
:type limit: int
|
768
|
-
:param filter: Optional. Expression to filter the result set.
|
768
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
769
769
|
:type filter: str
|
770
770
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
771
771
|
:type sort_by: List[str]
|
@@ -788,7 +788,7 @@ class DataTypesApi:
|
|
788
788
|
return self.list_data_type_summaries_with_http_info(as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
789
789
|
|
790
790
|
@validate_arguments
|
791
|
-
def list_data_type_summaries_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version
|
791
|
+
def list_data_type_summaries_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" 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, **kwargs) -> ApiResponse: # noqa: E501
|
792
792
|
"""[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data # noqa: E501
|
793
793
|
|
794
794
|
List all data type summaries # noqa: E501
|
@@ -798,13 +798,13 @@ class DataTypesApi:
|
|
798
798
|
>>> thread = api.list_data_type_summaries_with_http_info(as_at, page, limit, filter, sort_by, async_req=True)
|
799
799
|
>>> result = thread.get()
|
800
800
|
|
801
|
-
:param as_at: The asAt datetime at which to list the data type summaries. Defaults to returning the latest version
|
801
|
+
:param as_at: The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.
|
802
802
|
:type as_at: datetime
|
803
|
-
:param page: The pagination token to use to continue listing data type summaries. This
|
803
|
+
:param page: The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.
|
804
804
|
:type page: str
|
805
805
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
806
806
|
:type limit: int
|
807
|
-
:param filter: Optional. Expression to filter the result set.
|
807
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
808
808
|
:type filter: str
|
809
809
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
810
810
|
:type sort_by: List[str]
|
@@ -929,15 +929,15 @@ class DataTypesApi:
|
|
929
929
|
|
930
930
|
|
931
931
|
@overload
|
932
|
-
async def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
932
|
+
async def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ResourceListOfDataType: # noqa: E501
|
933
933
|
...
|
934
934
|
|
935
935
|
@overload
|
936
|
-
def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
936
|
+
def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfDataType: # noqa: E501
|
937
937
|
...
|
938
938
|
|
939
939
|
@validate_arguments
|
940
|
-
def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
940
|
+
def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfDataType, Awaitable[ResourceListOfDataType]]: # noqa: E501
|
941
941
|
"""ListDataTypes: List data types # noqa: E501
|
942
942
|
|
943
943
|
List all data types in a specified scope # noqa: E501
|
@@ -957,7 +957,7 @@ class DataTypesApi:
|
|
957
957
|
:type sort_by: List[str]
|
958
958
|
:param limit: Optional. When paginating, limit the number of returned results to this many.
|
959
959
|
:type limit: int
|
960
|
-
:param filter: Optional. Expression to filter the result set.
|
960
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
961
961
|
:type filter: str
|
962
962
|
:param async_req: Whether to execute the request asynchronously.
|
963
963
|
:type async_req: bool, optional
|
@@ -978,7 +978,7 @@ class DataTypesApi:
|
|
978
978
|
return self.list_data_types_with_http_info(scope, as_at, include_system, sort_by, limit, filter, **kwargs) # noqa: E501
|
979
979
|
|
980
980
|
@validate_arguments
|
981
|
-
def list_data_types_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
981
|
+
def list_data_types_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
982
982
|
"""ListDataTypes: List data types # noqa: E501
|
983
983
|
|
984
984
|
List all data types in a specified scope # noqa: E501
|
@@ -998,7 +998,7 @@ class DataTypesApi:
|
|
998
998
|
:type sort_by: List[str]
|
999
999
|
:param limit: Optional. When paginating, limit the number of returned results to this many.
|
1000
1000
|
:type limit: int
|
1001
|
-
:param filter: Optional. Expression to filter the result set.
|
1001
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
1002
1002
|
:type filter: str
|
1003
1003
|
:param async_req: Whether to execute the request asynchronously.
|
1004
1004
|
:type async_req: bool, optional
|
@@ -1136,7 +1136,7 @@ class DataTypesApi:
|
|
1136
1136
|
def update_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], update_data_type_request : Annotated[UpdateDataTypeRequest, Field(..., description="The updated definition of the data type")], async_req: Optional[bool]=None, **kwargs) -> Union[DataType, Awaitable[DataType]]: # noqa: E501
|
1137
1137
|
"""[EARLY ACCESS] UpdateDataType: Update data type definition # noqa: E501
|
1138
1138
|
|
1139
|
-
Update the definition of the specified existing data type
|
1139
|
+
Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types # noqa: E501
|
1140
1140
|
This method makes a synchronous HTTP request by default. To make an
|
1141
1141
|
asynchronous HTTP request, please pass async_req=True
|
1142
1142
|
|
@@ -1171,7 +1171,7 @@ class DataTypesApi:
|
|
1171
1171
|
def update_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], update_data_type_request : Annotated[UpdateDataTypeRequest, Field(..., description="The updated definition of the data type")], **kwargs) -> ApiResponse: # noqa: E501
|
1172
1172
|
"""[EARLY ACCESS] UpdateDataType: Update data type definition # noqa: E501
|
1173
1173
|
|
1174
|
-
Update the definition of the specified existing data type
|
1174
|
+
Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types # noqa: E501
|
1175
1175
|
This method makes a synchronous HTTP request by default. To make an
|
1176
1176
|
asynchronous HTTP request, please pass async_req=True
|
1177
1177
|
|