lusid-sdk 2.1.912__py3-none-any.whl → 2.1.914__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +139 -130
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_calendar_entry.py +21 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +1 -1
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/transaction_settlement_instruction.py +5 -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.912.dist-info → lusid_sdk-2.1.914.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.912.dist-info → lusid_sdk-2.1.914.dist-info}/RECORD +333 -333
- {lusid_sdk-2.1.912.dist-info → lusid_sdk-2.1.914.dist-info}/WHEEL +0 -0
lusid/api/search_api.py
CHANGED
@@ -57,27 +57,27 @@ class SearchApi:
|
|
57
57
|
|
58
58
|
|
59
59
|
@overload
|
60
|
-
async def instruments_search(self, instrument_search_property : Annotated[conlist(InstrumentSearchProperty), Field(..., description="A collection of instrument properties to search for. LUSID will return instruments for any matched
|
60
|
+
async def instruments_search(self, instrument_search_property : Annotated[conlist(InstrumentSearchProperty), Field(..., description="A collection of instrument properties to search for. LUSID will return instruments for any matched properties.")], mastered_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.")] = None, mastered_only : Annotated[Optional[StrictBool], Field(description="If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies.")] = None, **kwargs) -> List[InstrumentMatch]: # noqa: E501
|
61
61
|
...
|
62
62
|
|
63
63
|
@overload
|
64
|
-
def instruments_search(self, instrument_search_property : Annotated[conlist(InstrumentSearchProperty), Field(..., description="A collection of instrument properties to search for. LUSID will return instruments for any matched
|
64
|
+
def instruments_search(self, instrument_search_property : Annotated[conlist(InstrumentSearchProperty), Field(..., description="A collection of instrument properties to search for. LUSID will return instruments for any matched properties.")], mastered_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.")] = None, mastered_only : Annotated[Optional[StrictBool], Field(description="If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies.")] = None, async_req: Optional[bool]=True, **kwargs) -> List[InstrumentMatch]: # noqa: E501
|
65
65
|
...
|
66
66
|
|
67
67
|
@validate_arguments
|
68
|
-
def instruments_search(self, instrument_search_property : Annotated[conlist(InstrumentSearchProperty), Field(..., description="A collection of instrument properties to search for. LUSID will return instruments for any matched
|
68
|
+
def instruments_search(self, instrument_search_property : Annotated[conlist(InstrumentSearchProperty), Field(..., description="A collection of instrument properties to search for. LUSID will return instruments for any matched properties.")], mastered_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.")] = None, mastered_only : Annotated[Optional[StrictBool], Field(description="If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[List[InstrumentMatch], Awaitable[List[InstrumentMatch]]]: # noqa: E501
|
69
69
|
"""[EARLY ACCESS] InstrumentsSearch: Instruments search # noqa: E501
|
70
70
|
|
71
|
-
Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service,
|
71
|
+
Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service, currently OpenFIGI. # noqa: E501
|
72
72
|
This method makes a synchronous HTTP request by default. To make an
|
73
73
|
asynchronous HTTP request, please pass async_req=True
|
74
74
|
|
75
75
|
>>> thread = api.instruments_search(instrument_search_property, mastered_effective_at, mastered_only, scope, async_req=True)
|
76
76
|
>>> result = thread.get()
|
77
77
|
|
78
|
-
:param instrument_search_property: A collection of instrument properties to search for. LUSID will return instruments for any matched
|
78
|
+
:param instrument_search_property: A collection of instrument properties to search for. LUSID will return instruments for any matched properties. (required)
|
79
79
|
:type instrument_search_property: List[InstrumentSearchProperty]
|
80
|
-
:param mastered_effective_at: The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that
|
80
|
+
:param mastered_effective_at: The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.
|
81
81
|
:type mastered_effective_at: str
|
82
82
|
:param mastered_only: If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.
|
83
83
|
:type mastered_only: bool
|
@@ -102,19 +102,19 @@ class SearchApi:
|
|
102
102
|
return self.instruments_search_with_http_info(instrument_search_property, mastered_effective_at, mastered_only, scope, **kwargs) # noqa: E501
|
103
103
|
|
104
104
|
@validate_arguments
|
105
|
-
def instruments_search_with_http_info(self, instrument_search_property : Annotated[conlist(InstrumentSearchProperty), Field(..., description="A collection of instrument properties to search for. LUSID will return instruments for any matched
|
105
|
+
def instruments_search_with_http_info(self, instrument_search_property : Annotated[conlist(InstrumentSearchProperty), Field(..., description="A collection of instrument properties to search for. LUSID will return instruments for any matched properties.")], mastered_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.")] = None, mastered_only : Annotated[Optional[StrictBool], Field(description="If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
106
106
|
"""[EARLY ACCESS] InstrumentsSearch: Instruments search # noqa: E501
|
107
107
|
|
108
|
-
Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service,
|
108
|
+
Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service, currently OpenFIGI. # 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
|
|
112
112
|
>>> thread = api.instruments_search_with_http_info(instrument_search_property, mastered_effective_at, mastered_only, scope, async_req=True)
|
113
113
|
>>> result = thread.get()
|
114
114
|
|
115
|
-
:param instrument_search_property: A collection of instrument properties to search for. LUSID will return instruments for any matched
|
115
|
+
:param instrument_search_property: A collection of instrument properties to search for. LUSID will return instruments for any matched properties. (required)
|
116
116
|
:type instrument_search_property: List[InstrumentSearchProperty]
|
117
|
-
:param mastered_effective_at: The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that
|
117
|
+
:param mastered_effective_at: The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.
|
118
118
|
:type mastered_effective_at: str
|
119
119
|
:param mastered_only: If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.
|
120
120
|
:type mastered_only: bool
|
@@ -240,15 +240,15 @@ class SearchApi:
|
|
240
240
|
|
241
241
|
|
242
242
|
@overload
|
243
|
-
async def search_portfolio_groups(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
243
|
+
async def search_portfolio_groups(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, **kwargs) -> PagedResourceListOfPortfolioGroupSearchResult: # noqa: E501
|
244
244
|
...
|
245
245
|
|
246
246
|
@overload
|
247
|
-
def search_portfolio_groups(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
247
|
+
def search_portfolio_groups(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPortfolioGroupSearchResult: # noqa: E501
|
248
248
|
...
|
249
249
|
|
250
250
|
@validate_arguments
|
251
|
-
def search_portfolio_groups(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
251
|
+
def search_portfolio_groups(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPortfolioGroupSearchResult, Awaitable[PagedResourceListOfPortfolioGroupSearchResult]]: # noqa: E501
|
252
252
|
"""SearchPortfolioGroups: Search Portfolio Groups # noqa: E501
|
253
253
|
|
254
254
|
Search through all portfolio groups # noqa: E501
|
@@ -260,7 +260,7 @@ class SearchApi:
|
|
260
260
|
|
261
261
|
:param search: A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
262
262
|
:type search: str
|
263
|
-
:param filter: Expression to filter the result set.
|
263
|
+
:param filter: Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
264
264
|
:type filter: str
|
265
265
|
:param sort_by: Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
|
266
266
|
:type sort_by: str
|
@@ -287,7 +287,7 @@ class SearchApi:
|
|
287
287
|
return self.search_portfolio_groups_with_http_info(search, filter, sort_by, limit, page, **kwargs) # noqa: E501
|
288
288
|
|
289
289
|
@validate_arguments
|
290
|
-
def search_portfolio_groups_with_http_info(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
290
|
+
def search_portfolio_groups_with_http_info(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
291
291
|
"""SearchPortfolioGroups: Search Portfolio Groups # noqa: E501
|
292
292
|
|
293
293
|
Search through all portfolio groups # noqa: E501
|
@@ -299,7 +299,7 @@ class SearchApi:
|
|
299
299
|
|
300
300
|
:param search: A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
301
301
|
:type search: str
|
302
|
-
:param filter: Expression to filter the result set.
|
302
|
+
:param filter: Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
303
303
|
:type filter: str
|
304
304
|
:param sort_by: Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
|
305
305
|
:type sort_by: str
|
@@ -424,15 +424,15 @@ class SearchApi:
|
|
424
424
|
|
425
425
|
|
426
426
|
@overload
|
427
|
-
async def search_portfolios(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
427
|
+
async def search_portfolios(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the portfolio Type, use \"type eq 'Transaction'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, **kwargs) -> PagedResourceListOfPortfolioSearchResult: # noqa: E501
|
428
428
|
...
|
429
429
|
|
430
430
|
@overload
|
431
|
-
def search_portfolios(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
431
|
+
def search_portfolios(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the portfolio Type, use \"type eq 'Transaction'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPortfolioSearchResult: # noqa: E501
|
432
432
|
...
|
433
433
|
|
434
434
|
@validate_arguments
|
435
|
-
def search_portfolios(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
435
|
+
def search_portfolios(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the portfolio Type, use \"type eq 'Transaction'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPortfolioSearchResult, Awaitable[PagedResourceListOfPortfolioSearchResult]]: # noqa: E501
|
436
436
|
"""SearchPortfolios: Search Portfolios # noqa: E501
|
437
437
|
|
438
438
|
Search through all portfolios # noqa: E501
|
@@ -444,7 +444,7 @@ class SearchApi:
|
|
444
444
|
|
445
445
|
:param search: A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
446
446
|
:type search: str
|
447
|
-
:param filter: Expression to filter the result set.
|
447
|
+
:param filter: Expression to filter the result set. For example, to filter on the portfolio Type, use \"type eq 'Transaction'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
448
448
|
:type filter: str
|
449
449
|
:param sort_by: Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
|
450
450
|
:type sort_by: str
|
@@ -471,7 +471,7 @@ class SearchApi:
|
|
471
471
|
return self.search_portfolios_with_http_info(search, filter, sort_by, limit, page, **kwargs) # noqa: E501
|
472
472
|
|
473
473
|
@validate_arguments
|
474
|
-
def search_portfolios_with_http_info(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
474
|
+
def search_portfolios_with_http_info(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the portfolio Type, use \"type eq 'Transaction'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
475
475
|
"""SearchPortfolios: Search Portfolios # noqa: E501
|
476
476
|
|
477
477
|
Search through all portfolios # noqa: E501
|
@@ -483,7 +483,7 @@ class SearchApi:
|
|
483
483
|
|
484
484
|
:param search: A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
485
485
|
:type search: str
|
486
|
-
:param filter: Expression to filter the result set.
|
486
|
+
:param filter: Expression to filter the result set. For example, to filter on the portfolio Type, use \"type eq 'Transaction'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
487
487
|
:type filter: str
|
488
488
|
:param sort_by: Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
|
489
489
|
:type sort_by: str
|
@@ -608,15 +608,15 @@ class SearchApi:
|
|
608
608
|
|
609
609
|
|
610
610
|
@overload
|
611
|
-
async def search_properties(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
611
|
+
async def search_properties(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Value Type, use \"valueType eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, **kwargs) -> PagedResourceListOfPropertyDefinitionSearchResult: # noqa: E501
|
612
612
|
...
|
613
613
|
|
614
614
|
@overload
|
615
|
-
def search_properties(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
615
|
+
def search_properties(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Value Type, use \"valueType eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPropertyDefinitionSearchResult: # noqa: E501
|
616
616
|
...
|
617
617
|
|
618
618
|
@validate_arguments
|
619
|
-
def search_properties(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
619
|
+
def search_properties(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Value Type, use \"valueType eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPropertyDefinitionSearchResult, Awaitable[PagedResourceListOfPropertyDefinitionSearchResult]]: # noqa: E501
|
620
620
|
"""SearchProperties: Search Property Definitions # noqa: E501
|
621
621
|
|
622
622
|
Search through all Property Definitions # noqa: E501
|
@@ -628,7 +628,7 @@ class SearchApi:
|
|
628
628
|
|
629
629
|
:param search: A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
630
630
|
:type search: str
|
631
|
-
:param filter: Expression to filter the result set.
|
631
|
+
:param filter: Expression to filter the result set. For example, to filter on the Value Type, use \"valueType eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
632
632
|
:type filter: str
|
633
633
|
:param sort_by: Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
|
634
634
|
:type sort_by: str
|
@@ -655,7 +655,7 @@ class SearchApi:
|
|
655
655
|
return self.search_properties_with_http_info(search, filter, sort_by, limit, page, **kwargs) # noqa: E501
|
656
656
|
|
657
657
|
@validate_arguments
|
658
|
-
def search_properties_with_http_info(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.
|
658
|
+
def search_properties_with_http_info(self, search : Annotated[Optional[StrictStr], Field( description="A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the Value Type, use \"valueType eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records")] = None, page : Annotated[Optional[StrictStr], Field( description="Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
659
659
|
"""SearchProperties: Search Property Definitions # noqa: E501
|
660
660
|
|
661
661
|
Search through all Property Definitions # noqa: E501
|
@@ -667,7 +667,7 @@ class SearchApi:
|
|
667
667
|
|
668
668
|
:param search: A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. 'Port*'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
669
669
|
:type search: str
|
670
|
-
:param filter: Expression to filter the result set.
|
670
|
+
:param filter: Expression to filter the result set. For example, to filter on the Value Type, use \"valueType eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
671
671
|
:type filter: str
|
672
672
|
:param sort_by: Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
|
673
673
|
:type sort_by: str
|
lusid/api/sequences_api.py
CHANGED
@@ -223,15 +223,15 @@ class SequencesApi:
|
|
223
223
|
|
224
224
|
|
225
225
|
@overload
|
226
|
-
async def get_sequence(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely
|
226
|
+
async def get_sequence(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely identifies the sequence.")], **kwargs) -> SequenceDefinition: # noqa: E501
|
227
227
|
...
|
228
228
|
|
229
229
|
@overload
|
230
|
-
def get_sequence(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely
|
230
|
+
def get_sequence(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely identifies the sequence.")], async_req: Optional[bool]=True, **kwargs) -> SequenceDefinition: # noqa: E501
|
231
231
|
...
|
232
232
|
|
233
233
|
@validate_arguments
|
234
|
-
def get_sequence(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely
|
234
|
+
def get_sequence(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely identifies the sequence.")], async_req: Optional[bool]=None, **kwargs) -> Union[SequenceDefinition, Awaitable[SequenceDefinition]]: # noqa: E501
|
235
235
|
"""[EARLY ACCESS] GetSequence: Get a specified sequence # noqa: E501
|
236
236
|
|
237
237
|
Return the details of a specified sequence # noqa: E501
|
@@ -243,7 +243,7 @@ class SequencesApi:
|
|
243
243
|
|
244
244
|
:param scope: Scope of the sequence. (required)
|
245
245
|
:type scope: str
|
246
|
-
:param code: Code of the sequence. This together with stated scope uniquely
|
246
|
+
:param code: Code of the sequence. This together with stated scope uniquely identifies the sequence. (required)
|
247
247
|
:type code: str
|
248
248
|
:param async_req: Whether to execute the request asynchronously.
|
249
249
|
:type async_req: bool, optional
|
@@ -264,7 +264,7 @@ class SequencesApi:
|
|
264
264
|
return self.get_sequence_with_http_info(scope, code, **kwargs) # noqa: E501
|
265
265
|
|
266
266
|
@validate_arguments
|
267
|
-
def get_sequence_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely
|
267
|
+
def get_sequence_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely identifies the sequence.")], **kwargs) -> ApiResponse: # noqa: E501
|
268
268
|
"""[EARLY ACCESS] GetSequence: Get a specified sequence # noqa: E501
|
269
269
|
|
270
270
|
Return the details of a specified sequence # noqa: E501
|
@@ -276,7 +276,7 @@ class SequencesApi:
|
|
276
276
|
|
277
277
|
:param scope: Scope of the sequence. (required)
|
278
278
|
:type scope: str
|
279
|
-
:param code: Code of the sequence. This together with stated scope uniquely
|
279
|
+
:param code: Code of the sequence. This together with stated scope uniquely identifies the sequence. (required)
|
280
280
|
:type code: str
|
281
281
|
:param async_req: Whether to execute the request asynchronously.
|
282
282
|
:type async_req: bool, optional
|
@@ -383,15 +383,15 @@ class SequencesApi:
|
|
383
383
|
|
384
384
|
|
385
385
|
@overload
|
386
|
-
async def list_sequences(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing sequences from a previous call to list sequences. This
|
386
|
+
async def list_sequences(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 500 if not specified.")] = 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) -> PagedResourceListOfSequenceDefinition: # noqa: E501
|
387
387
|
...
|
388
388
|
|
389
389
|
@overload
|
390
|
-
def list_sequences(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing sequences from a previous call to list sequences. This
|
390
|
+
def list_sequences(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 500 if not specified.")] = 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) -> PagedResourceListOfSequenceDefinition: # noqa: E501
|
391
391
|
...
|
392
392
|
|
393
393
|
@validate_arguments
|
394
|
-
def list_sequences(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing sequences from a previous call to list sequences. This
|
394
|
+
def list_sequences(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 500 if not specified.")] = 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[PagedResourceListOfSequenceDefinition, Awaitable[PagedResourceListOfSequenceDefinition]]: # noqa: E501
|
395
395
|
"""[EARLY ACCESS] ListSequences: List Sequences # noqa: E501
|
396
396
|
|
397
397
|
List sequences which satisfies filtering criteria. # noqa: E501
|
@@ -401,11 +401,11 @@ class SequencesApi:
|
|
401
401
|
>>> thread = api.list_sequences(page, limit, filter, async_req=True)
|
402
402
|
>>> result = thread.get()
|
403
403
|
|
404
|
-
:param page: The pagination token to use to continue listing sequences from a previous call to list sequences. This
|
404
|
+
:param page: The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call.
|
405
405
|
:type page: str
|
406
406
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 500 if not specified.
|
407
407
|
:type limit: int
|
408
|
-
:param filter: Expression to filter the result set.
|
408
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
409
409
|
:type filter: str
|
410
410
|
:param async_req: Whether to execute the request asynchronously.
|
411
411
|
:type async_req: bool, optional
|
@@ -426,7 +426,7 @@ class SequencesApi:
|
|
426
426
|
return self.list_sequences_with_http_info(page, limit, filter, **kwargs) # noqa: E501
|
427
427
|
|
428
428
|
@validate_arguments
|
429
|
-
def list_sequences_with_http_info(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing sequences from a previous call to list sequences. This
|
429
|
+
def list_sequences_with_http_info(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 500 if not specified.")] = 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
|
430
430
|
"""[EARLY ACCESS] ListSequences: List Sequences # noqa: E501
|
431
431
|
|
432
432
|
List sequences which satisfies filtering criteria. # noqa: E501
|
@@ -436,11 +436,11 @@ class SequencesApi:
|
|
436
436
|
>>> thread = api.list_sequences_with_http_info(page, limit, filter, async_req=True)
|
437
437
|
>>> result = thread.get()
|
438
438
|
|
439
|
-
:param page: The pagination token to use to continue listing sequences from a previous call to list sequences. This
|
439
|
+
:param page: The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call.
|
440
440
|
:type page: str
|
441
441
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 500 if not specified.
|
442
442
|
:type limit: int
|
443
|
-
:param filter: Expression to filter the result set.
|
443
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
444
444
|
:type filter: str
|
445
445
|
:param async_req: Whether to execute the request asynchronously.
|
446
446
|
:type async_req: bool, optional
|
@@ -551,15 +551,15 @@ class SequencesApi:
|
|
551
551
|
|
552
552
|
|
553
553
|
@overload
|
554
|
-
async def next(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely
|
554
|
+
async def next(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely identifies the sequence.")], batch : Annotated[Optional[conint(strict=True)], Field(description="Number of sequences items to return for the specified sequence. Default to 1 if not specified.")] = None, **kwargs) -> NextValueInSequenceResponse: # noqa: E501
|
555
555
|
...
|
556
556
|
|
557
557
|
@overload
|
558
|
-
def next(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely
|
558
|
+
def next(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely identifies the sequence.")], batch : Annotated[Optional[conint(strict=True)], Field(description="Number of sequences items to return for the specified sequence. Default to 1 if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> NextValueInSequenceResponse: # noqa: E501
|
559
559
|
...
|
560
560
|
|
561
561
|
@validate_arguments
|
562
|
-
def next(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely
|
562
|
+
def next(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely identifies the sequence.")], batch : Annotated[Optional[conint(strict=True)], Field(description="Number of sequences items to return for the specified sequence. Default to 1 if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[NextValueInSequenceResponse, Awaitable[NextValueInSequenceResponse]]: # noqa: E501
|
563
563
|
"""[EARLY ACCESS] Next: Get next values from sequence # noqa: E501
|
564
564
|
|
565
565
|
Get the next set of values from a specified sequence # noqa: E501
|
@@ -571,7 +571,7 @@ class SequencesApi:
|
|
571
571
|
|
572
572
|
:param scope: Scope of the sequence. (required)
|
573
573
|
:type scope: str
|
574
|
-
:param code: Code of the sequence. This together with stated scope uniquely
|
574
|
+
:param code: Code of the sequence. This together with stated scope uniquely identifies the sequence. (required)
|
575
575
|
:type code: str
|
576
576
|
:param batch: Number of sequences items to return for the specified sequence. Default to 1 if not specified.
|
577
577
|
:type batch: int
|
@@ -594,7 +594,7 @@ class SequencesApi:
|
|
594
594
|
return self.next_with_http_info(scope, code, batch, **kwargs) # noqa: E501
|
595
595
|
|
596
596
|
@validate_arguments
|
597
|
-
def next_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely
|
597
|
+
def next_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the sequence.")], code : Annotated[StrictStr, Field(..., description="Code of the sequence. This together with stated scope uniquely identifies the sequence.")], batch : Annotated[Optional[conint(strict=True)], Field(description="Number of sequences items to return for the specified sequence. Default to 1 if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
598
598
|
"""[EARLY ACCESS] Next: Get next values from sequence # noqa: E501
|
599
599
|
|
600
600
|
Get the next set of values from a specified sequence # noqa: E501
|
@@ -606,7 +606,7 @@ class SequencesApi:
|
|
606
606
|
|
607
607
|
:param scope: Scope of the sequence. (required)
|
608
608
|
:type scope: str
|
609
|
-
:param code: Code of the sequence. This together with stated scope uniquely
|
609
|
+
:param code: Code of the sequence. This together with stated scope uniquely identifies the sequence. (required)
|
610
610
|
:type code: str
|
611
611
|
:param batch: Number of sequences items to return for the specified sequence. Default to 1 if not specified.
|
612
612
|
:type batch: int
|