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
@@ -388,15 +388,15 @@ class AborConfigurationApi:
|
|
388
388
|
|
389
389
|
|
390
390
|
@overload
|
391
|
-
async def get_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration.
|
391
|
+
async def get_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, **kwargs) -> AborConfiguration: # noqa: E501
|
392
392
|
...
|
393
393
|
|
394
394
|
@overload
|
395
|
-
def get_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration.
|
395
|
+
def get_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=True, **kwargs) -> AborConfiguration: # noqa: E501
|
396
396
|
...
|
397
397
|
|
398
398
|
@validate_arguments
|
399
|
-
def get_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration.
|
399
|
+
def get_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AborConfiguration, Awaitable[AborConfiguration]]: # noqa: E501
|
400
400
|
"""[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. # noqa: E501
|
401
401
|
|
402
402
|
Retrieve the definition of a particular AborConfiguration. # noqa: E501
|
@@ -414,7 +414,7 @@ class AborConfigurationApi:
|
|
414
414
|
:type effective_at: str
|
415
415
|
:param as_at: The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.
|
416
416
|
:type as_at: datetime
|
417
|
-
:param property_keys: A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration.
|
417
|
+
:param property_keys: A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned.
|
418
418
|
:type property_keys: List[str]
|
419
419
|
:param async_req: Whether to execute the request asynchronously.
|
420
420
|
:type async_req: bool, optional
|
@@ -435,7 +435,7 @@ class AborConfigurationApi:
|
|
435
435
|
return self.get_abor_configuration_with_http_info(scope, code, effective_at, as_at, property_keys, **kwargs) # noqa: E501
|
436
436
|
|
437
437
|
@validate_arguments
|
438
|
-
def get_abor_configuration_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration.
|
438
|
+
def get_abor_configuration_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
439
439
|
"""[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. # noqa: E501
|
440
440
|
|
441
441
|
Retrieve the definition of a particular AborConfiguration. # noqa: E501
|
@@ -453,7 +453,7 @@ class AborConfigurationApi:
|
|
453
453
|
:type effective_at: str
|
454
454
|
:param as_at: The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.
|
455
455
|
:type as_at: datetime
|
456
|
-
:param property_keys: A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration.
|
456
|
+
:param property_keys: A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned.
|
457
457
|
:type property_keys: List[str]
|
458
458
|
:param async_req: Whether to execute the request asynchronously.
|
459
459
|
:type async_req: bool, optional
|
@@ -755,15 +755,15 @@ class AborConfigurationApi:
|
|
755
755
|
|
756
756
|
|
757
757
|
@overload
|
758
|
-
async def list_abor_configurations(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID
|
758
|
+
async def list_abor_configurations(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing AborConfiguration; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the AborConfiguration type, specify \"id.Code eq 'AborConfiguration1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'.")] = None, **kwargs) -> PagedResourceListOfAborConfiguration: # noqa: E501
|
759
759
|
...
|
760
760
|
|
761
761
|
@overload
|
762
|
-
def list_abor_configurations(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID
|
762
|
+
def list_abor_configurations(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing AborConfiguration; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the AborConfiguration type, specify \"id.Code eq 'AborConfiguration1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfAborConfiguration: # noqa: E501
|
763
763
|
...
|
764
764
|
|
765
765
|
@validate_arguments
|
766
|
-
def list_abor_configurations(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID
|
766
|
+
def list_abor_configurations(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing AborConfiguration; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the AborConfiguration type, specify \"id.Code eq 'AborConfiguration1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfAborConfiguration, Awaitable[PagedResourceListOfAborConfiguration]]: # noqa: E501
|
767
767
|
"""[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. # noqa: E501
|
768
768
|
|
769
769
|
List all the AborConfiguration matching particular criteria. # noqa: E501
|
@@ -773,19 +773,19 @@ class AborConfigurationApi:
|
|
773
773
|
>>> thread = api.list_abor_configurations(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
|
774
774
|
>>> result = thread.get()
|
775
775
|
|
776
|
-
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID
|
776
|
+
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified.
|
777
777
|
:type effective_at: str
|
778
778
|
:param as_at: The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified.
|
779
779
|
:type as_at: datetime
|
780
|
-
:param page: The pagination token to use to continue listing AborConfiguration; this
|
780
|
+
:param page: The pagination token to use to continue listing AborConfiguration; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
781
781
|
:type page: str
|
782
782
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
783
783
|
:type limit: int
|
784
|
-
:param filter: Expression to filter the results.
|
784
|
+
:param filter: Expression to filter the results. For example, to filter on the AborConfiguration type, specify \"id.Code eq 'AborConfiguration1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
785
785
|
:type filter: str
|
786
786
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
787
787
|
:type sort_by: List[str]
|
788
|
-
:param property_keys: A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration.
|
788
|
+
:param property_keys: A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'.
|
789
789
|
:type property_keys: List[str]
|
790
790
|
:param async_req: Whether to execute the request asynchronously.
|
791
791
|
:type async_req: bool, optional
|
@@ -806,7 +806,7 @@ class AborConfigurationApi:
|
|
806
806
|
return self.list_abor_configurations_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, **kwargs) # noqa: E501
|
807
807
|
|
808
808
|
@validate_arguments
|
809
|
-
def list_abor_configurations_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID
|
809
|
+
def list_abor_configurations_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing AborConfiguration; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the AborConfiguration type, specify \"id.Code eq 'AborConfiguration1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
810
810
|
"""[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. # noqa: E501
|
811
811
|
|
812
812
|
List all the AborConfiguration matching particular criteria. # noqa: E501
|
@@ -816,19 +816,19 @@ class AborConfigurationApi:
|
|
816
816
|
>>> thread = api.list_abor_configurations_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
|
817
817
|
>>> result = thread.get()
|
818
818
|
|
819
|
-
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID
|
819
|
+
:param effective_at: The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified.
|
820
820
|
:type effective_at: str
|
821
821
|
:param as_at: The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified.
|
822
822
|
:type as_at: datetime
|
823
|
-
:param page: The pagination token to use to continue listing AborConfiguration; this
|
823
|
+
:param page: The pagination token to use to continue listing AborConfiguration; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
|
824
824
|
:type page: str
|
825
825
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
826
826
|
:type limit: int
|
827
|
-
:param filter: Expression to filter the results.
|
827
|
+
:param filter: Expression to filter the results. For example, to filter on the AborConfiguration type, specify \"id.Code eq 'AborConfiguration1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
828
828
|
:type filter: str
|
829
829
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
830
830
|
:type sort_by: List[str]
|
831
|
-
:param property_keys: A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration.
|
831
|
+
:param property_keys: A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'.
|
832
832
|
:type property_keys: List[str]
|
833
833
|
:param async_req: Whether to execute the request asynchronously.
|
834
834
|
:type async_req: bool, optional
|
@@ -960,15 +960,15 @@ class AborConfigurationApi:
|
|
960
960
|
|
961
961
|
|
962
962
|
@overload
|
963
|
-
async def patch_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration.
|
963
|
+
async def patch_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.")], **kwargs) -> AborConfiguration: # noqa: E501
|
964
964
|
...
|
965
965
|
|
966
966
|
@overload
|
967
|
-
def patch_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration.
|
967
|
+
def patch_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.")], async_req: Optional[bool]=True, **kwargs) -> AborConfiguration: # noqa: E501
|
968
968
|
...
|
969
969
|
|
970
970
|
@validate_arguments
|
971
|
-
def patch_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration.
|
971
|
+
def patch_abor_configuration(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.")], async_req: Optional[bool]=None, **kwargs) -> Union[AborConfiguration, Awaitable[AborConfiguration]]: # noqa: E501
|
972
972
|
"""[EXPERIMENTAL] PatchAborConfiguration: Patch Abor Configuration. # noqa: E501
|
973
973
|
|
974
974
|
Create or update certain fields for a particular AborConfiguration. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, PostingModuleCodes, CleardownModuleCodes. # noqa: E501
|
@@ -980,7 +980,7 @@ class AborConfigurationApi:
|
|
980
980
|
|
981
981
|
:param scope: The scope of the AborConfiguration. (required)
|
982
982
|
:type scope: str
|
983
|
-
:param code: The code of the AborConfiguration.
|
983
|
+
:param code: The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. (required)
|
984
984
|
:type code: str
|
985
985
|
:param operation: The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. (required)
|
986
986
|
:type operation: List[Operation]
|
@@ -1003,7 +1003,7 @@ class AborConfigurationApi:
|
|
1003
1003
|
return self.patch_abor_configuration_with_http_info(scope, code, operation, **kwargs) # noqa: E501
|
1004
1004
|
|
1005
1005
|
@validate_arguments
|
1006
|
-
def patch_abor_configuration_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration.
|
1006
|
+
def patch_abor_configuration_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.")], **kwargs) -> ApiResponse: # noqa: E501
|
1007
1007
|
"""[EXPERIMENTAL] PatchAborConfiguration: Patch Abor Configuration. # noqa: E501
|
1008
1008
|
|
1009
1009
|
Create or update certain fields for a particular AborConfiguration. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, PostingModuleCodes, CleardownModuleCodes. # noqa: E501
|
@@ -1015,7 +1015,7 @@ class AborConfigurationApi:
|
|
1015
1015
|
|
1016
1016
|
:param scope: The scope of the AborConfiguration. (required)
|
1017
1017
|
:type scope: str
|
1018
|
-
:param code: The code of the AborConfiguration.
|
1018
|
+
:param code: The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. (required)
|
1019
1019
|
:type code: str
|
1020
1020
|
:param operation: The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. (required)
|
1021
1021
|
:type operation: List[Operation]
|
@@ -1135,18 +1135,18 @@ class AborConfigurationApi:
|
|
1135
1135
|
|
1136
1136
|
|
1137
1137
|
@overload
|
1138
|
-
async def upsert_abor_configuration_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
1138
|
+
async def upsert_abor_configuration_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"AborConfiguration/Manager/Id\".")] = None, **kwargs) -> AborConfigurationProperties: # noqa: E501
|
1139
1139
|
...
|
1140
1140
|
|
1141
1141
|
@overload
|
1142
|
-
def upsert_abor_configuration_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
1142
|
+
def upsert_abor_configuration_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"AborConfiguration/Manager/Id\".")] = None, async_req: Optional[bool]=True, **kwargs) -> AborConfigurationProperties: # noqa: E501
|
1143
1143
|
...
|
1144
1144
|
|
1145
1145
|
@validate_arguments
|
1146
|
-
def upsert_abor_configuration_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
1146
|
+
def upsert_abor_configuration_properties(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"AborConfiguration/Manager/Id\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AborConfigurationProperties, Awaitable[AborConfigurationProperties]]: # noqa: E501
|
1147
1147
|
"""[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties # noqa: E501
|
1148
1148
|
|
1149
|
-
Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it
|
1149
|
+
Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'AborConfiguration'. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
1150
1150
|
This method makes a synchronous HTTP request by default. To make an
|
1151
1151
|
asynchronous HTTP request, please pass async_req=True
|
1152
1152
|
|
@@ -1157,7 +1157,7 @@ class AborConfigurationApi:
|
|
1157
1157
|
:type scope: str
|
1158
1158
|
:param code: The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration. (required)
|
1159
1159
|
:type code: str
|
1160
|
-
:param request_body: The properties to be updated or inserted onto the chart of account. Each property in
|
1160
|
+
:param request_body: The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"AborConfiguration/Manager/Id\".
|
1161
1161
|
:type request_body: Dict[str, ModelProperty]
|
1162
1162
|
:param async_req: Whether to execute the request asynchronously.
|
1163
1163
|
:type async_req: bool, optional
|
@@ -1178,10 +1178,10 @@ class AborConfigurationApi:
|
|
1178
1178
|
return self.upsert_abor_configuration_properties_with_http_info(scope, code, request_body, **kwargs) # noqa: E501
|
1179
1179
|
|
1180
1180
|
@validate_arguments
|
1181
|
-
def upsert_abor_configuration_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in
|
1181
|
+
def upsert_abor_configuration_properties_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the AborConfiguration to update or insert the properties onto.")], code : Annotated[StrictStr, Field(..., description="The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"AborConfiguration/Manager/Id\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1182
1182
|
"""[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties # noqa: E501
|
1183
1183
|
|
1184
|
-
Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it
|
1184
|
+
Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'AborConfiguration'. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
|
1185
1185
|
This method makes a synchronous HTTP request by default. To make an
|
1186
1186
|
asynchronous HTTP request, please pass async_req=True
|
1187
1187
|
|
@@ -1192,7 +1192,7 @@ class AborConfigurationApi:
|
|
1192
1192
|
:type scope: str
|
1193
1193
|
:param code: The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration. (required)
|
1194
1194
|
:type code: str
|
1195
|
-
:param request_body: The properties to be updated or inserted onto the chart of account. Each property in
|
1195
|
+
:param request_body: The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"AborConfiguration/Manager/Id\".
|
1196
1196
|
:type request_body: Dict[str, ModelProperty]
|
1197
1197
|
:param async_req: Whether to execute the request asynchronously.
|
1198
1198
|
:type async_req: bool, optional
|
@@ -379,15 +379,15 @@ class AddressKeyDefinitionApi:
|
|
379
379
|
|
380
380
|
|
381
381
|
@overload
|
382
|
-
async def list_address_key_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the address key definition.
|
382
|
+
async def list_address_key_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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) -> PagedResourceListOfAddressKeyDefinition: # noqa: E501
|
383
383
|
...
|
384
384
|
|
385
385
|
@overload
|
386
|
-
def list_address_key_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the address key definition.
|
386
|
+
def list_address_key_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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) -> PagedResourceListOfAddressKeyDefinition: # noqa: E501
|
387
387
|
...
|
388
388
|
|
389
389
|
@validate_arguments
|
390
|
-
def list_address_key_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the address key definition.
|
390
|
+
def list_address_key_definitions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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[PagedResourceListOfAddressKeyDefinition, Awaitable[PagedResourceListOfAddressKeyDefinition]]: # noqa: E501
|
391
391
|
"""[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. # noqa: E501
|
392
392
|
|
393
393
|
Fetch the last pre-AsAt date version of each address key definition. # noqa: E501
|
@@ -397,13 +397,13 @@ class AddressKeyDefinitionApi:
|
|
397
397
|
>>> thread = api.list_address_key_definitions(as_at, page, limit, filter, async_req=True)
|
398
398
|
>>> result = thread.get()
|
399
399
|
|
400
|
-
:param as_at: The asAt datetime at which to retrieve the address key definition.
|
400
|
+
:param as_at: The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified.
|
401
401
|
:type as_at: datetime
|
402
|
-
:param page: The pagination token to use to continue listing address key definitions from a previous call to list address key definitions.
|
402
|
+
:param page: The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
403
403
|
:type page: str
|
404
404
|
:param limit: When paginating, limit the number of returned results to this many.
|
405
405
|
:type limit: int
|
406
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
406
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
407
407
|
:type filter: str
|
408
408
|
:param async_req: Whether to execute the request asynchronously.
|
409
409
|
:type async_req: bool, optional
|
@@ -424,7 +424,7 @@ class AddressKeyDefinitionApi:
|
|
424
424
|
return self.list_address_key_definitions_with_http_info(as_at, page, limit, filter, **kwargs) # noqa: E501
|
425
425
|
|
426
426
|
@validate_arguments
|
427
|
-
def list_address_key_definitions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the address key definition.
|
427
|
+
def list_address_key_definitions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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
|
428
428
|
"""[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. # noqa: E501
|
429
429
|
|
430
430
|
Fetch the last pre-AsAt date version of each address key definition. # noqa: E501
|
@@ -434,13 +434,13 @@ class AddressKeyDefinitionApi:
|
|
434
434
|
>>> thread = api.list_address_key_definitions_with_http_info(as_at, page, limit, filter, async_req=True)
|
435
435
|
>>> result = thread.get()
|
436
436
|
|
437
|
-
:param as_at: The asAt datetime at which to retrieve the address key definition.
|
437
|
+
:param as_at: The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified.
|
438
438
|
:type as_at: datetime
|
439
|
-
:param page: The pagination token to use to continue listing address key definitions from a previous call to list address key definitions.
|
439
|
+
:param page: The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
440
440
|
:type page: str
|
441
441
|
:param limit: When paginating, limit the number of returned results to this many.
|
442
442
|
:type limit: int
|
443
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
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
|
@@ -217,15 +217,15 @@ class AggregatedReturnsApi:
|
|
217
217
|
|
218
218
|
|
219
219
|
@overload
|
220
|
-
async def get_returns_entity(self, scope : Annotated[StrictStr, Field(..., description="Returns entity scope.")], code : Annotated[StrictStr, Field(..., description="Returns entity code.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the returns entity. Defaults to return
|
220
|
+
async def get_returns_entity(self, scope : Annotated[StrictStr, Field(..., description="Returns entity scope.")], code : Annotated[StrictStr, Field(..., description="Returns entity code.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> ReturnsEntity: # noqa: E501
|
221
221
|
...
|
222
222
|
|
223
223
|
@overload
|
224
|
-
def get_returns_entity(self, scope : Annotated[StrictStr, Field(..., description="Returns entity scope.")], code : Annotated[StrictStr, Field(..., description="Returns entity code.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the returns entity. Defaults to return
|
224
|
+
def get_returns_entity(self, scope : Annotated[StrictStr, Field(..., description="Returns entity scope.")], code : Annotated[StrictStr, Field(..., description="Returns entity code.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ReturnsEntity: # noqa: E501
|
225
225
|
...
|
226
226
|
|
227
227
|
@validate_arguments
|
228
|
-
def get_returns_entity(self, scope : Annotated[StrictStr, Field(..., description="Returns entity scope.")], code : Annotated[StrictStr, Field(..., description="Returns entity code.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the returns entity. Defaults to return
|
228
|
+
def get_returns_entity(self, scope : Annotated[StrictStr, Field(..., description="Returns entity scope.")], code : Annotated[StrictStr, Field(..., description="Returns entity code.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ReturnsEntity, Awaitable[ReturnsEntity]]: # noqa: E501
|
229
229
|
"""[EXPERIMENTAL] GetReturnsEntity: Get returns entity. # noqa: E501
|
230
230
|
|
231
231
|
Get returns entity. # noqa: E501
|
@@ -239,7 +239,7 @@ class AggregatedReturnsApi:
|
|
239
239
|
:type scope: str
|
240
240
|
:param code: Returns entity code. (required)
|
241
241
|
:type code: str
|
242
|
-
:param as_at: The asAt datetime at which to retrieve the returns entity. Defaults to return
|
242
|
+
:param as_at: The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified.
|
243
243
|
:type as_at: datetime
|
244
244
|
:param async_req: Whether to execute the request asynchronously.
|
245
245
|
:type async_req: bool, optional
|
@@ -260,7 +260,7 @@ class AggregatedReturnsApi:
|
|
260
260
|
return self.get_returns_entity_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
261
261
|
|
262
262
|
@validate_arguments
|
263
|
-
def get_returns_entity_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Returns entity scope.")], code : Annotated[StrictStr, Field(..., description="Returns entity code.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the returns entity. Defaults to return
|
263
|
+
def get_returns_entity_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Returns entity scope.")], code : Annotated[StrictStr, Field(..., description="Returns entity code.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
264
264
|
"""[EXPERIMENTAL] GetReturnsEntity: Get returns entity. # noqa: E501
|
265
265
|
|
266
266
|
Get returns entity. # noqa: E501
|
@@ -274,7 +274,7 @@ class AggregatedReturnsApi:
|
|
274
274
|
:type scope: str
|
275
275
|
:param code: Returns entity code. (required)
|
276
276
|
:type code: str
|
277
|
-
:param as_at: The asAt datetime at which to retrieve the returns entity. Defaults to return
|
277
|
+
:param as_at: The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified.
|
278
278
|
:type as_at: datetime
|
279
279
|
:param async_req: Whether to execute the request asynchronously.
|
280
280
|
:type async_req: bool, optional
|
@@ -388,15 +388,15 @@ class AggregatedReturnsApi:
|
|
388
388
|
|
389
389
|
|
390
390
|
@overload
|
391
|
-
async def list_returns_entities(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definitions. Defaults to return
|
391
|
+
async def list_returns_entities(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified.")] = None, **kwargs) -> ResourceListOfReturnsEntity: # noqa: E501
|
392
392
|
...
|
393
393
|
|
394
394
|
@overload
|
395
|
-
def list_returns_entities(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definitions. Defaults to return
|
395
|
+
def list_returns_entities(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfReturnsEntity: # noqa: E501
|
396
396
|
...
|
397
397
|
|
398
398
|
@validate_arguments
|
399
|
-
def list_returns_entities(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definitions. Defaults to return
|
399
|
+
def list_returns_entities(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfReturnsEntity, Awaitable[ResourceListOfReturnsEntity]]: # noqa: E501
|
400
400
|
"""[EXPERIMENTAL] ListReturnsEntities: List returns entities. # noqa: E501
|
401
401
|
|
402
402
|
List returns entities. # noqa: E501
|
@@ -406,7 +406,7 @@ class AggregatedReturnsApi:
|
|
406
406
|
>>> thread = api.list_returns_entities(as_at, async_req=True)
|
407
407
|
>>> result = thread.get()
|
408
408
|
|
409
|
-
:param as_at: The asAt datetime at which to retrieve the relation definitions. Defaults to return
|
409
|
+
:param as_at: The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified.
|
410
410
|
:type as_at: datetime
|
411
411
|
:param async_req: Whether to execute the request asynchronously.
|
412
412
|
:type async_req: bool, optional
|
@@ -427,7 +427,7 @@ class AggregatedReturnsApi:
|
|
427
427
|
return self.list_returns_entities_with_http_info(as_at, **kwargs) # noqa: E501
|
428
428
|
|
429
429
|
@validate_arguments
|
430
|
-
def list_returns_entities_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definitions. Defaults to return
|
430
|
+
def list_returns_entities_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
431
431
|
"""[EXPERIMENTAL] ListReturnsEntities: List returns entities. # noqa: E501
|
432
432
|
|
433
433
|
List returns entities. # noqa: E501
|
@@ -437,7 +437,7 @@ class AggregatedReturnsApi:
|
|
437
437
|
>>> thread = api.list_returns_entities_with_http_info(as_at, async_req=True)
|
438
438
|
>>> result = thread.get()
|
439
439
|
|
440
|
-
:param as_at: The asAt datetime at which to retrieve the relation definitions. Defaults to return
|
440
|
+
:param as_at: The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified.
|
441
441
|
:type as_at: datetime
|
442
442
|
:param async_req: Whether to execute the request asynchronously.
|
443
443
|
:type async_req: bool, optional
|
lusid/api/aggregation_api.py
CHANGED
@@ -233,29 +233,29 @@ class AggregationApi:
|
|
233
233
|
|
234
234
|
|
235
235
|
@overload
|
236
|
-
async def get_queryable_keys(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys.
|
236
|
+
async def get_queryable_keys(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ResourceListOfAggregationQuery: # noqa: E501
|
237
237
|
...
|
238
238
|
|
239
239
|
@overload
|
240
|
-
def get_queryable_keys(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys.
|
240
|
+
def get_queryable_keys(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfAggregationQuery: # noqa: E501
|
241
241
|
...
|
242
242
|
|
243
243
|
@validate_arguments
|
244
|
-
def get_queryable_keys(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys.
|
244
|
+
def get_queryable_keys(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAggregationQuery, Awaitable[ResourceListOfAggregationQuery]]: # noqa: E501
|
245
245
|
"""GetQueryableKeys: Query the set of supported \"addresses\" that can be queried from the aggregation endpoint. # noqa: E501
|
246
246
|
|
247
|
-
When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys,
|
247
|
+
When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return. # noqa: E501
|
248
248
|
This method makes a synchronous HTTP request by default. To make an
|
249
249
|
asynchronous HTTP request, please pass async_req=True
|
250
250
|
|
251
251
|
>>> thread = api.get_queryable_keys(page, limit, filter, async_req=True)
|
252
252
|
>>> result = thread.get()
|
253
253
|
|
254
|
-
:param page: The pagination token to use to continue listing queryable keys from a previous call to list queryable keys.
|
254
|
+
:param page: The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.
|
255
255
|
:type page: str
|
256
256
|
:param limit: When paginating, limit the number of returned results to this many.
|
257
257
|
:type limit: int
|
258
|
-
:param filter: Expression to filter the result set.
|
258
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
259
259
|
:type filter: str
|
260
260
|
:param async_req: Whether to execute the request asynchronously.
|
261
261
|
:type async_req: bool, optional
|
@@ -276,21 +276,21 @@ class AggregationApi:
|
|
276
276
|
return self.get_queryable_keys_with_http_info(page, limit, filter, **kwargs) # noqa: E501
|
277
277
|
|
278
278
|
@validate_arguments
|
279
|
-
def get_queryable_keys_with_http_info(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys.
|
279
|
+
def get_queryable_keys_with_http_info(self, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
280
280
|
"""GetQueryableKeys: Query the set of supported \"addresses\" that can be queried from the aggregation endpoint. # noqa: E501
|
281
281
|
|
282
|
-
When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys,
|
282
|
+
When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return. # noqa: E501
|
283
283
|
This method makes a synchronous HTTP request by default. To make an
|
284
284
|
asynchronous HTTP request, please pass async_req=True
|
285
285
|
|
286
286
|
>>> thread = api.get_queryable_keys_with_http_info(page, limit, filter, async_req=True)
|
287
287
|
>>> result = thread.get()
|
288
288
|
|
289
|
-
:param page: The pagination token to use to continue listing queryable keys from a previous call to list queryable keys.
|
289
|
+
:param page: The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.
|
290
290
|
:type page: str
|
291
291
|
:param limit: When paginating, limit the number of returned results to this many.
|
292
292
|
:type limit: int
|
293
|
-
:param filter: Expression to filter the result set.
|
293
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
294
294
|
:type filter: str
|
295
295
|
:param async_req: Whether to execute the request asynchronously.
|
296
296
|
:type async_req: bool, optional
|