lusid-sdk 2.1.911__py3-none-any.whl → 2.1.913__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +126 -126
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_holding.py +6 -2
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +6 -4
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/settlement_schedule.py +20 -2
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/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_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/RECORD +333 -333
- {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/WHEEL +0 -0
@@ -222,15 +222,15 @@ class DerivedTransactionPortfoliosApi:
|
|
222
222
|
|
223
223
|
|
224
224
|
@overload
|
225
|
-
async def delete_derived_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the derived transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the derived transaction portfolio. Together with the scope this uniquely identifies
|
225
|
+
async def delete_derived_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the derived transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the change.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
226
226
|
...
|
227
227
|
|
228
228
|
@overload
|
229
|
-
def delete_derived_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the derived transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the derived transaction portfolio. Together with the scope this uniquely identifies
|
229
|
+
def delete_derived_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the derived transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the change.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
|
230
230
|
...
|
231
231
|
|
232
232
|
@validate_arguments
|
233
|
-
def delete_derived_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the derived transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the derived transaction portfolio. Together with the scope this uniquely identifies
|
233
|
+
def delete_derived_portfolio_details(self, scope : Annotated[StrictStr, Field(..., description="The scope of the derived transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the change.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
234
234
|
"""[EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details # noqa: E501
|
235
235
|
|
236
236
|
Delete all the portfolio details for a derived transaction portfolio. # noqa: E501
|
@@ -242,7 +242,7 @@ class DerivedTransactionPortfoliosApi:
|
|
242
242
|
|
243
243
|
:param scope: The scope of the derived transaction portfolio. (required)
|
244
244
|
:type scope: str
|
245
|
-
:param code: The code of the derived transaction portfolio. Together with the scope this uniquely identifies
|
245
|
+
:param code: The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio. (required)
|
246
246
|
:type code: str
|
247
247
|
:param effective_at: The effective date of the change.
|
248
248
|
:type effective_at: str
|
@@ -265,7 +265,7 @@ class DerivedTransactionPortfoliosApi:
|
|
265
265
|
return self.delete_derived_portfolio_details_with_http_info(scope, code, effective_at, **kwargs) # noqa: E501
|
266
266
|
|
267
267
|
@validate_arguments
|
268
|
-
def delete_derived_portfolio_details_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the derived transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the derived transaction portfolio. Together with the scope this uniquely identifies
|
268
|
+
def delete_derived_portfolio_details_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the derived transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date of the change.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
269
269
|
"""[EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details # noqa: E501
|
270
270
|
|
271
271
|
Delete all the portfolio details for a derived transaction portfolio. # noqa: E501
|
@@ -277,7 +277,7 @@ class DerivedTransactionPortfoliosApi:
|
|
277
277
|
|
278
278
|
:param scope: The scope of the derived transaction portfolio. (required)
|
279
279
|
:type scope: str
|
280
|
-
:param code: The code of the derived transaction portfolio. Together with the scope this uniquely identifies
|
280
|
+
:param code: The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio. (required)
|
281
281
|
:type code: str
|
282
282
|
:param effective_at: The effective date of the change.
|
283
283
|
:type effective_at: str
|
lusid/api/entities_api.py
CHANGED
@@ -72,7 +72,7 @@ class EntitiesApi:
|
|
72
72
|
def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the Custom Entity.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custom Entity. 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 Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustomEntityEntity, Awaitable[CustomEntityEntity]]: # noqa: E501
|
73
73
|
"""GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
|
74
74
|
|
75
|
-
Retrieve a particular Custom Entity instance.
|
75
|
+
Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion. # noqa: E501
|
76
76
|
This method makes a synchronous HTTP request by default. To make an
|
77
77
|
asynchronous HTTP request, please pass async_req=True
|
78
78
|
|
@@ -109,7 +109,7 @@ class EntitiesApi:
|
|
109
109
|
def get_custom_entity_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the Custom Entity.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Custom Entity. 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 Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
110
110
|
"""GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
|
111
111
|
|
112
|
-
Retrieve a particular Custom Entity instance.
|
112
|
+
Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion. # noqa: E501
|
113
113
|
This method makes a synchronous HTTP request by default. To make an
|
114
114
|
asynchronous HTTP request, please pass async_req=True
|
115
115
|
|
@@ -252,7 +252,7 @@ class EntitiesApi:
|
|
252
252
|
def get_data_type_by_entity_unique_id(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the DataType definition.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DataTypeEntity, Awaitable[DataTypeEntity]]: # noqa: E501
|
253
253
|
"""GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
|
254
254
|
|
255
|
-
Retrieve the definition of a particular DataType.
|
255
|
+
Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion. # noqa: E501
|
256
256
|
This method makes a synchronous HTTP request by default. To make an
|
257
257
|
asynchronous HTTP request, please pass async_req=True
|
258
258
|
|
@@ -287,7 +287,7 @@ class EntitiesApi:
|
|
287
287
|
def get_data_type_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the DataType definition.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
288
288
|
"""GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
|
289
289
|
|
290
|
-
Retrieve the definition of a particular DataType.
|
290
|
+
Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion. # noqa: E501
|
291
291
|
This method makes a synchronous HTTP request by default. To make an
|
292
292
|
asynchronous HTTP request, please pass async_req=True
|
293
293
|
|
@@ -413,15 +413,15 @@ class EntitiesApi:
|
|
413
413
|
|
414
414
|
|
415
415
|
@overload
|
416
|
-
async def get_entity_history(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing change history information from a previous call to list change
|
416
|
+
async def get_entity_history(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ResourceListOfChangeInterval: # noqa: E501
|
417
417
|
...
|
418
418
|
|
419
419
|
@overload
|
420
|
-
def get_entity_history(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing change history information from a previous call to list change
|
420
|
+
def get_entity_history(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfChangeInterval: # noqa: E501
|
421
421
|
...
|
422
422
|
|
423
423
|
@validate_arguments
|
424
|
-
def get_entity_history(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing change history information from a previous call to list change
|
424
|
+
def get_entity_history(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfChangeInterval, Awaitable[ResourceListOfChangeInterval]]: # noqa: E501
|
425
425
|
"""GetEntityHistory: List an entity's history information # noqa: E501
|
426
426
|
|
427
427
|
Retrieve a page of an entity's change history up to a particular point in AsAt time. # noqa: E501
|
@@ -437,11 +437,11 @@ class EntitiesApi:
|
|
437
437
|
:type entity_unique_id: str
|
438
438
|
:param as_at: The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.
|
439
439
|
:type as_at: datetime
|
440
|
-
:param page: The pagination token to use to continue listing change history information from a previous call to list change
|
440
|
+
:param page: The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request.
|
441
441
|
:type page: str
|
442
442
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
443
443
|
:type limit: int
|
444
|
-
:param filter: Expression to filter the result set.
|
444
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
445
445
|
:type filter: str
|
446
446
|
:param sort_by: A list of field names suffixed by \" ASC\" or \" DESC\"
|
447
447
|
:type sort_by: List[str]
|
@@ -464,7 +464,7 @@ class EntitiesApi:
|
|
464
464
|
return self.get_entity_history_with_http_info(entity_type, entity_unique_id, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
465
465
|
|
466
466
|
@validate_arguments
|
467
|
-
def get_entity_history_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing change history information from a previous call to list change
|
467
|
+
def get_entity_history_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
468
468
|
"""GetEntityHistory: List an entity's history information # noqa: E501
|
469
469
|
|
470
470
|
Retrieve a page of an entity's change history up to a particular point in AsAt time. # noqa: E501
|
@@ -480,11 +480,11 @@ class EntitiesApi:
|
|
480
480
|
:type entity_unique_id: str
|
481
481
|
:param as_at: The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.
|
482
482
|
:type as_at: datetime
|
483
|
-
:param page: The pagination token to use to continue listing change history information from a previous call to list change
|
483
|
+
:param page: The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request.
|
484
484
|
:type page: str
|
485
485
|
:param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
|
486
486
|
:type limit: int
|
487
|
-
:param filter: Expression to filter the result set.
|
487
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
488
488
|
:type filter: str
|
489
489
|
:param sort_by: A list of field names suffixed by \" ASC\" or \" DESC\"
|
490
490
|
:type sort_by: List[str]
|
@@ -628,7 +628,7 @@ class EntitiesApi:
|
|
628
628
|
def get_instrument_by_entity_unique_id(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the instrument definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Instrument definition. 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 instrument definition. Defaults to returning the latest version of the instrument definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentEntity, Awaitable[InstrumentEntity]]: # noqa: E501
|
629
629
|
"""GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
|
630
630
|
|
631
|
-
Retrieve the definition of a particular instrument.
|
631
|
+
Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion. # noqa: E501
|
632
632
|
This method makes a synchronous HTTP request by default. To make an
|
633
633
|
asynchronous HTTP request, please pass async_req=True
|
634
634
|
|
@@ -665,7 +665,7 @@ class EntitiesApi:
|
|
665
665
|
def get_instrument_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the instrument definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the Instrument definition. 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 instrument definition. Defaults to returning the latest version of the instrument definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
666
666
|
"""GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
|
667
667
|
|
668
|
-
Retrieve the definition of a particular instrument.
|
668
|
+
Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion. # noqa: E501
|
669
669
|
This method makes a synchronous HTTP request by default. To make an
|
670
670
|
asynchronous HTTP request, please pass async_req=True
|
671
671
|
|
@@ -808,7 +808,7 @@ class EntitiesApi:
|
|
808
808
|
def get_portfolio_by_entity_unique_id(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. 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 portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PortfolioEntity, Awaitable[PortfolioEntity]]: # noqa: E501
|
809
809
|
"""GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
|
810
810
|
|
811
|
-
Retrieve the definition of a particular portfolio.
|
811
|
+
Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. # noqa: E501
|
812
812
|
This method makes a synchronous HTTP request by default. To make an
|
813
813
|
asynchronous HTTP request, please pass async_req=True
|
814
814
|
|
@@ -845,7 +845,7 @@ class EntitiesApi:
|
|
845
845
|
def get_portfolio_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the portfolio definition. 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 portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
846
846
|
"""GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
|
847
847
|
|
848
|
-
Retrieve the definition of a particular portfolio.
|
848
|
+
Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. # noqa: E501
|
849
849
|
This method makes a synchronous HTTP request by default. To make an
|
850
850
|
asynchronous HTTP request, please pass async_req=True
|
851
851
|
|
@@ -988,7 +988,7 @@ class EntitiesApi:
|
|
988
988
|
def get_portfolio_changes(self, scope : Annotated[StrictStr, Field(..., description="The scope")], effective_at : Annotated[StrictStr, Field(..., description="The effective date of the origin.")], as_at : Annotated[Optional[datetime], Field(description="The as-at date of the origin.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfChange, Awaitable[ResourceListOfChange]]: # noqa: E501
|
989
989
|
"""GetPortfolioChanges: Get the next change to each portfolio in a scope. # noqa: E501
|
990
990
|
|
991
|
-
Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time.
|
991
|
+
Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). # noqa: E501
|
992
992
|
This method makes a synchronous HTTP request by default. To make an
|
993
993
|
asynchronous HTTP request, please pass async_req=True
|
994
994
|
|
@@ -1023,7 +1023,7 @@ class EntitiesApi:
|
|
1023
1023
|
def get_portfolio_changes_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope")], effective_at : Annotated[StrictStr, Field(..., description="The effective date of the origin.")], as_at : Annotated[Optional[datetime], Field(description="The as-at date of the origin.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1024
1024
|
"""GetPortfolioChanges: Get the next change to each portfolio in a scope. # noqa: E501
|
1025
1025
|
|
1026
|
-
Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time.
|
1026
|
+
Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). # noqa: E501
|
1027
1027
|
This method makes a synchronous HTTP request by default. To make an
|
1028
1028
|
asynchronous HTTP request, please pass async_req=True
|
1029
1029
|
|
@@ -1159,7 +1159,7 @@ class EntitiesApi:
|
|
1159
1159
|
def get_property_definition_by_entity_unique_id(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the property definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime at which to retrieve the property definition. 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 property definition. Defaults to returning the latest version of the property definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PropertyDefinitionEntity, Awaitable[PropertyDefinitionEntity]]: # noqa: E501
|
1160
1160
|
"""GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
|
1161
1161
|
|
1162
|
-
Retrieve a particular property definition.
|
1162
|
+
Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion. # noqa: E501
|
1163
1163
|
This method makes a synchronous HTTP request by default. To make an
|
1164
1164
|
asynchronous HTTP request, please pass async_req=True
|
1165
1165
|
|
@@ -1196,7 +1196,7 @@ class EntitiesApi:
|
|
1196
1196
|
def get_property_definition_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[StrictStr, Field(..., description="The universally unique identifier of the property definition.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime at which to retrieve the property definition. 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 property definition. Defaults to returning the latest version of the property definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1197
1197
|
"""GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
|
1198
1198
|
|
1199
|
-
Retrieve a particular property definition.
|
1199
|
+
Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion. # noqa: E501
|
1200
1200
|
This method makes a synchronous HTTP request by default. To make an
|
1201
1201
|
asynchronous HTTP request, please pass async_req=True
|
1202
1202
|
|
lusid/api/executions_api.py
CHANGED
@@ -70,7 +70,7 @@ class ExecutionsApi:
|
|
70
70
|
def delete_execution(self, scope : Annotated[StrictStr, Field(..., description="The execution scope.")], code : Annotated[StrictStr, Field(..., description="The execution's code. This, together with the scope uniquely identifies the execution to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
71
71
|
"""[EARLY ACCESS] DeleteExecution: Delete execution # noqa: E501
|
72
72
|
|
73
|
-
Delete an execution. Deletion will be valid from the execution's creation datetime.
|
73
|
+
Delete an execution. Deletion will be valid from the execution's creation datetime. This means that the execution will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
74
74
|
This method makes a synchronous HTTP request by default. To make an
|
75
75
|
asynchronous HTTP request, please pass async_req=True
|
76
76
|
|
@@ -103,7 +103,7 @@ class ExecutionsApi:
|
|
103
103
|
def delete_execution_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The execution scope.")], code : Annotated[StrictStr, Field(..., description="The execution's code. This, together with the scope uniquely identifies the execution to delete.")], **kwargs) -> ApiResponse: # noqa: E501
|
104
104
|
"""[EARLY ACCESS] DeleteExecution: Delete execution # noqa: E501
|
105
105
|
|
106
|
-
Delete an execution. Deletion will be valid from the execution's creation datetime.
|
106
|
+
Delete an execution. Deletion will be valid from the execution's creation datetime. This means that the execution will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
107
107
|
This method makes a synchronous HTTP request by default. To make an
|
108
108
|
asynchronous HTTP request, please pass async_req=True
|
109
109
|
|
@@ -219,15 +219,15 @@ class ExecutionsApi:
|
|
219
219
|
|
220
220
|
|
221
221
|
@overload
|
222
|
-
async def get_execution(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the execution belongs.")], code : Annotated[StrictStr, Field(..., description="The execution's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto the execution.
|
222
|
+
async def get_execution(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the execution belongs.")], code : Annotated[StrictStr, Field(..., description="The execution's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto the execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".")] = None, **kwargs) -> Execution: # noqa: E501
|
223
223
|
...
|
224
224
|
|
225
225
|
@overload
|
226
|
-
def get_execution(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the execution belongs.")], code : Annotated[StrictStr, Field(..., description="The execution's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto the execution.
|
226
|
+
def get_execution(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the execution belongs.")], code : Annotated[StrictStr, Field(..., description="The execution's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto the execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> Execution: # noqa: E501
|
227
227
|
...
|
228
228
|
|
229
229
|
@validate_arguments
|
230
|
-
def get_execution(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the execution belongs.")], code : Annotated[StrictStr, Field(..., description="The execution's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto the execution.
|
230
|
+
def get_execution(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the execution belongs.")], code : Annotated[StrictStr, Field(..., description="The execution's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto the execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Execution, Awaitable[Execution]]: # noqa: E501
|
231
231
|
"""[EARLY ACCESS] GetExecution: Get Execution # noqa: E501
|
232
232
|
|
233
233
|
Fetch a Execution that matches the specified identifier # noqa: E501
|
@@ -243,7 +243,7 @@ class ExecutionsApi:
|
|
243
243
|
:type code: str
|
244
244
|
:param as_at: The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.
|
245
245
|
:type as_at: datetime
|
246
|
-
:param property_keys: A list of property keys from the \"Execution\" domain to decorate onto the execution.
|
246
|
+
:param property_keys: A list of property keys from the \"Execution\" domain to decorate onto the execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".
|
247
247
|
:type property_keys: List[str]
|
248
248
|
:param async_req: Whether to execute the request asynchronously.
|
249
249
|
:type async_req: bool, optional
|
@@ -264,7 +264,7 @@ class ExecutionsApi:
|
|
264
264
|
return self.get_execution_with_http_info(scope, code, as_at, property_keys, **kwargs) # noqa: E501
|
265
265
|
|
266
266
|
@validate_arguments
|
267
|
-
def get_execution_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the execution belongs.")], code : Annotated[StrictStr, Field(..., description="The execution's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto the execution.
|
267
|
+
def get_execution_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the execution belongs.")], code : Annotated[StrictStr, Field(..., description="The execution's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto the execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
268
268
|
"""[EARLY ACCESS] GetExecution: Get Execution # noqa: E501
|
269
269
|
|
270
270
|
Fetch a Execution that matches the specified identifier # noqa: E501
|
@@ -280,7 +280,7 @@ class ExecutionsApi:
|
|
280
280
|
:type code: str
|
281
281
|
:param as_at: The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.
|
282
282
|
:type as_at: datetime
|
283
|
-
:param property_keys: A list of property keys from the \"Execution\" domain to decorate onto the execution.
|
283
|
+
:param property_keys: A list of property keys from the \"Execution\" domain to decorate onto the execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".
|
284
284
|
:type property_keys: List[str]
|
285
285
|
:param async_req: Whether to execute the request asynchronously.
|
286
286
|
:type async_req: bool, optional
|
@@ -399,15 +399,15 @@ class ExecutionsApi:
|
|
399
399
|
|
400
400
|
|
401
401
|
@overload
|
402
|
-
async def list_executions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing execution from a previous call to list executions.
|
402
|
+
async def list_executions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing execution from a previous call to list executions. 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, 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, 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> PagedResourceListOfExecution: # noqa: E501
|
403
403
|
...
|
404
404
|
|
405
405
|
@overload
|
406
|
-
def list_executions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing execution from a previous call to list executions.
|
406
|
+
def list_executions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing execution from a previous call to list executions. 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, 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, 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfExecution: # noqa: E501
|
407
407
|
...
|
408
408
|
|
409
409
|
@validate_arguments
|
410
|
-
def list_executions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing execution from a previous call to list executions.
|
410
|
+
def list_executions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing execution from a previous call to list executions. 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, 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, 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfExecution, Awaitable[PagedResourceListOfExecution]]: # noqa: E501
|
411
411
|
"""ListExecutions: List Executions # noqa: E501
|
412
412
|
|
413
413
|
Fetch the last pre-AsAt date version of each execution in scope (does not fetch the entire history). # noqa: E501
|
@@ -419,15 +419,15 @@ class ExecutionsApi:
|
|
419
419
|
|
420
420
|
:param as_at: The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.
|
421
421
|
:type as_at: datetime
|
422
|
-
:param page: The pagination token to use to continue listing execution from a previous call to list executions.
|
422
|
+
:param page: The pagination token to use to continue listing execution from a previous call to list executions. 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.
|
423
423
|
:type page: str
|
424
424
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
425
425
|
:type sort_by: List[str]
|
426
426
|
:param limit: When paginating, limit the number of returned results to this many.
|
427
427
|
:type limit: int
|
428
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
428
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
429
429
|
:type filter: str
|
430
|
-
:param property_keys: A list of property keys from the \"Execution\" domain to decorate onto each execution.
|
430
|
+
:param property_keys: A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
431
431
|
:type property_keys: List[str]
|
432
432
|
:param async_req: Whether to execute the request asynchronously.
|
433
433
|
:type async_req: bool, optional
|
@@ -448,7 +448,7 @@ class ExecutionsApi:
|
|
448
448
|
return self.list_executions_with_http_info(as_at, page, sort_by, limit, filter, property_keys, **kwargs) # noqa: E501
|
449
449
|
|
450
450
|
@validate_arguments
|
451
|
-
def list_executions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing execution from a previous call to list executions.
|
451
|
+
def list_executions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing execution from a previous call to list executions. 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, 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, 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
452
452
|
"""ListExecutions: List Executions # noqa: E501
|
453
453
|
|
454
454
|
Fetch the last pre-AsAt date version of each execution in scope (does not fetch the entire history). # noqa: E501
|
@@ -460,15 +460,15 @@ class ExecutionsApi:
|
|
460
460
|
|
461
461
|
:param as_at: The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.
|
462
462
|
:type as_at: datetime
|
463
|
-
:param page: The pagination token to use to continue listing execution from a previous call to list executions.
|
463
|
+
:param page: The pagination token to use to continue listing execution from a previous call to list executions. 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.
|
464
464
|
:type page: str
|
465
465
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
|
466
466
|
:type sort_by: List[str]
|
467
467
|
:param limit: When paginating, limit the number of returned results to this many.
|
468
468
|
:type limit: int
|
469
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here:
|
469
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
470
470
|
:type filter: str
|
471
|
-
:param property_keys: A list of property keys from the \"Execution\" domain to decorate onto each execution.
|
471
|
+
:param property_keys: A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\". All properties, except derived properties, are returned by default, without specifying here.
|
472
472
|
:type property_keys: List[str]
|
473
473
|
:param async_req: Whether to execute the request asynchronously.
|
474
474
|
:type async_req: bool, optional
|
lusid/api/fee_types_api.py
CHANGED
@@ -701,15 +701,15 @@ class FeeTypesApi:
|
|
701
701
|
|
702
702
|
|
703
703
|
@overload
|
704
|
-
async def list_fee_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing FeeTypes; this
|
704
|
+
async def list_fee_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing FeeTypes; 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 Code of the FeeType type, specify \"id.Code eq 'FeeType1'\". 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, **kwargs) -> PagedResourceListOfFeeType: # noqa: E501
|
705
705
|
...
|
706
706
|
|
707
707
|
@overload
|
708
|
-
def list_fee_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing FeeTypes; this
|
708
|
+
def list_fee_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing FeeTypes; 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 Code of the FeeType type, specify \"id.Code eq 'FeeType1'\". 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, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfFeeType: # noqa: E501
|
709
709
|
...
|
710
710
|
|
711
711
|
@validate_arguments
|
712
|
-
def list_fee_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing FeeTypes; this
|
712
|
+
def list_fee_types(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing FeeTypes; 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 Code of the FeeType type, specify \"id.Code eq 'FeeType1'\". 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, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfFeeType, Awaitable[PagedResourceListOfFeeType]]: # noqa: E501
|
713
713
|
"""[EXPERIMENTAL] ListFeeTypes: List FeeTypes # noqa: E501
|
714
714
|
|
715
715
|
List FeeTypes that contain templates used to create fee transactions. # noqa: E501
|
@@ -721,11 +721,11 @@ class FeeTypesApi:
|
|
721
721
|
|
722
722
|
:param as_at: The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.
|
723
723
|
:type as_at: datetime
|
724
|
-
:param page: The pagination token to use to continue listing FeeTypes; this
|
724
|
+
:param page: The pagination token to use to continue listing FeeTypes; 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.
|
725
725
|
:type page: str
|
726
726
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
727
727
|
:type limit: int
|
728
|
-
:param filter: Expression to filter the results.
|
728
|
+
:param filter: Expression to filter the results. For example, to filter on the Code of the FeeType type, specify \"id.Code eq 'FeeType1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
729
729
|
:type filter: str
|
730
730
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
731
731
|
:type sort_by: List[str]
|
@@ -748,7 +748,7 @@ class FeeTypesApi:
|
|
748
748
|
return self.list_fee_types_with_http_info(as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
749
749
|
|
750
750
|
@validate_arguments
|
751
|
-
def list_fee_types_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing FeeTypes; this
|
751
|
+
def list_fee_types_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing FeeTypes; 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 Code of the FeeType type, specify \"id.Code eq 'FeeType1'\". 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, **kwargs) -> ApiResponse: # noqa: E501
|
752
752
|
"""[EXPERIMENTAL] ListFeeTypes: List FeeTypes # noqa: E501
|
753
753
|
|
754
754
|
List FeeTypes that contain templates used to create fee transactions. # noqa: E501
|
@@ -760,11 +760,11 @@ class FeeTypesApi:
|
|
760
760
|
|
761
761
|
:param as_at: The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.
|
762
762
|
:type as_at: datetime
|
763
|
-
:param page: The pagination token to use to continue listing FeeTypes; this
|
763
|
+
:param page: The pagination token to use to continue listing FeeTypes; 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.
|
764
764
|
:type page: str
|
765
765
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
766
766
|
:type limit: int
|
767
|
-
:param filter: Expression to filter the results.
|
767
|
+
:param filter: Expression to filter the results. For example, to filter on the Code of the FeeType type, specify \"id.Code eq 'FeeType1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
768
768
|
:type filter: str
|
769
769
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
770
770
|
:type sort_by: List[str]
|