lusid-sdk 2.1.912__py3-none-any.whl → 2.1.914__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/api/abor_api.py +66 -66
- lusid/api/abor_configuration_api.py +32 -32
- lusid/api/address_key_definition_api.py +10 -10
- lusid/api/aggregated_returns_api.py +12 -12
- lusid/api/aggregation_api.py +10 -10
- lusid/api/allocations_api.py +24 -24
- lusid/api/amortisation_rule_sets_api.py +24 -24
- lusid/api/application_metadata_api.py +6 -6
- lusid/api/blocks_api.py +18 -18
- lusid/api/calendars_api.py +34 -34
- lusid/api/chart_of_accounts_api.py +122 -122
- lusid/api/check_definitions_api.py +38 -38
- lusid/api/complex_market_data_api.py +36 -36
- lusid/api/compliance_api.py +34 -34
- lusid/api/configuration_recipe_api.py +20 -20
- lusid/api/conventions_api.py +18 -18
- lusid/api/corporate_action_sources_api.py +32 -32
- lusid/api/counterparties_api.py +12 -12
- lusid/api/custom_data_models_api.py +16 -16
- lusid/api/custom_entities_api.py +40 -40
- lusid/api/custom_entity_definitions_api.py +10 -10
- lusid/api/custom_entity_types_api.py +10 -10
- lusid/api/cut_label_definitions_api.py +8 -8
- lusid/api/data_types_api.py +34 -34
- lusid/api/derived_transaction_portfolios_api.py +6 -6
- lusid/api/entities_api.py +20 -20
- lusid/api/executions_api.py +18 -18
- lusid/api/fee_types_api.py +8 -8
- lusid/api/fund_configuration_api.py +38 -38
- lusid/api/funds_api.py +139 -130
- lusid/api/group_reconciliations_api.py +84 -84
- lusid/api/identifier_definitions_api.py +30 -30
- lusid/api/instrument_event_types_api.py +40 -40
- lusid/api/instrument_events_api.py +34 -34
- lusid/api/instruments_api.py +138 -138
- lusid/api/investment_accounts_api.py +24 -24
- lusid/api/investor_records_api.py +26 -26
- lusid/api/legacy_compliance_api.py +46 -46
- lusid/api/legal_entities_api.py +114 -114
- lusid/api/order_graph_api.py +6 -6
- lusid/api/order_instructions_api.py +18 -18
- lusid/api/order_management_api.py +28 -28
- lusid/api/orders_api.py +18 -18
- lusid/api/packages_api.py +18 -18
- lusid/api/participations_api.py +18 -18
- lusid/api/persons_api.py +114 -114
- lusid/api/placements_api.py +18 -18
- lusid/api/portfolio_groups_api.py +156 -156
- lusid/api/portfolios_api.py +128 -128
- lusid/api/property_definitions_api.py +74 -74
- lusid/api/queryable_keys_api.py +6 -6
- lusid/api/quotes_api.py +36 -36
- lusid/api/reconciliations_api.py +42 -42
- lusid/api/reference_lists_api.py +8 -8
- lusid/api/reference_portfolio_api.py +30 -30
- lusid/api/relation_definitions_api.py +14 -14
- lusid/api/relationship_definitions_api.py +32 -32
- lusid/api/scopes_api.py +12 -12
- lusid/api/scripted_translation_api.py +22 -22
- lusid/api/search_api.py +28 -28
- lusid/api/sequences_api.py +20 -20
- lusid/api/staged_modifications_api.py +20 -20
- lusid/api/staging_rule_set_api.py +18 -18
- lusid/api/structured_result_data_api.py +38 -38
- lusid/api/system_configuration_api.py +20 -20
- lusid/api/tax_rule_sets_api.py +34 -34
- lusid/api/timelines_api.py +68 -68
- lusid/api/transaction_configuration_api.py +18 -18
- lusid/api/transaction_fees_api.py +42 -42
- lusid/api/transaction_portfolios_api.py +450 -450
- lusid/api/transfer_agency_api.py +2 -2
- lusid/api/translation_api.py +4 -4
- lusid/api/workspace_api.py +24 -24
- lusid/configuration.py +1 -1
- lusid/models/access_metadata_value.py +1 -1
- lusid/models/accumulation_event.py +1 -1
- lusid/models/additional_payment.py +1 -1
- lusid/models/address_definition.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/adjust_holding_for_date_request.py +1 -1
- lusid/models/adjust_holding_request.py +1 -1
- lusid/models/aggregate_spec.py +1 -1
- lusid/models/aggregation_context.py +1 -1
- lusid/models/aggregation_options.py +3 -3
- lusid/models/allocation.py +1 -1
- lusid/models/amortisation_event.py +2 -2
- lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
- lusid/models/asset_leg.py +2 -2
- lusid/models/basket.py +1 -1
- lusid/models/block.py +1 -1
- lusid/models/bond.py +5 -5
- lusid/models/bond_conversion_entry.py +3 -3
- lusid/models/bond_conversion_schedule.py +5 -5
- lusid/models/bond_coupon_event.py +1 -1
- lusid/models/bond_principal_event.py +1 -1
- lusid/models/bucketed_cash_flow_response.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +1 -1
- lusid/models/cap_floor.py +2 -2
- lusid/models/cash_and_security_offer_election.py +1 -1
- lusid/models/cash_dependency.py +2 -2
- lusid/models/cash_flow_event.py +1 -1
- lusid/models/cash_flow_lineage.py +2 -2
- lusid/models/cash_offer_election.py +1 -1
- lusid/models/cds_flow_conventions.py +5 -5
- lusid/models/cds_index.py +4 -4
- lusid/models/cds_protection_detail_specification.py +3 -3
- lusid/models/change_item.py +1 -1
- lusid/models/close_event.py +1 -1
- lusid/models/collateral.py +2 -2
- lusid/models/complex_bond.py +4 -4
- lusid/models/complex_market_data.py +1 -1
- lusid/models/complex_market_data_id.py +1 -1
- lusid/models/compounding.py +6 -6
- lusid/models/configuration_recipe.py +1 -1
- lusid/models/constant_volatility_surface.py +2 -2
- lusid/models/constituents_adjustment_header.py +1 -1
- lusid/models/contract_for_difference.py +6 -6
- lusid/models/conversion_event.py +9 -9
- lusid/models/corporate_action_transition_component_request.py +1 -1
- lusid/models/counterparty_agreement.py +1 -1
- lusid/models/counterparty_risk_information.py +1 -1
- lusid/models/counterparty_signatory.py +1 -1
- lusid/models/credit_default_swap.py +4 -4
- lusid/models/credit_premium_cash_flow_event.py +1 -1
- lusid/models/credit_rating.py +1 -1
- lusid/models/credit_spread_curve_data.py +3 -3
- lusid/models/credit_support_annex.py +6 -6
- lusid/models/curve_options.py +2 -2
- lusid/models/data_definition.py +3 -3
- lusid/models/data_map_key.py +1 -1
- lusid/models/data_mapping.py +1 -1
- lusid/models/dependency_source_filter.py +6 -6
- lusid/models/dialect.py +1 -1
- lusid/models/dialect_schema.py +1 -1
- lusid/models/discounting_dependency.py +2 -2
- lusid/models/dividend_option_event.py +1 -1
- lusid/models/dividend_reinvestment_event.py +1 -1
- lusid/models/early_redemption_election.py +1 -1
- lusid/models/early_redemption_event.py +2 -2
- lusid/models/economic_dependency.py +1 -1
- lusid/models/equity.py +1 -1
- lusid/models/equity_curve_by_prices_data.py +1 -1
- lusid/models/equity_curve_dependency.py +2 -2
- lusid/models/equity_model_options.py +1 -1
- lusid/models/equity_option.py +7 -7
- lusid/models/equity_swap.py +6 -6
- lusid/models/equity_vol_dependency.py +2 -2
- lusid/models/event_date_range.py +1 -1
- lusid/models/ex_dividend_configuration.py +3 -3
- lusid/models/exchange_traded_option.py +1 -1
- lusid/models/exchange_traded_option_contract_details.py +5 -5
- lusid/models/execution.py +1 -1
- lusid/models/exercise_event.py +1 -1
- lusid/models/exotic_instrument.py +1 -1
- lusid/models/expiry_event.py +1 -1
- lusid/models/fixed_leg.py +1 -1
- lusid/models/fixed_leg_all_of_overrides.py +1 -1
- lusid/models/fixed_schedule.py +3 -3
- lusid/models/flexible_deposit.py +2 -2
- lusid/models/flexible_loan.py +2 -2
- lusid/models/flexible_repo.py +10 -10
- lusid/models/flexible_repo_cash_flow_event.py +2 -2
- lusid/models/flexible_repo_collateral_event.py +2 -2
- lusid/models/flexible_repo_interest_payment_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +5 -5
- lusid/models/float_schedule.py +5 -5
- lusid/models/floating_leg.py +1 -1
- lusid/models/flow_convention_name.py +1 -1
- lusid/models/flow_conventions.py +9 -9
- lusid/models/forward_rate_agreement.py +1 -1
- lusid/models/fund_calendar_entry.py +21 -1
- lusid/models/fund_share_class.py +4 -4
- lusid/models/fund_valuation_request.py +4 -4
- lusid/models/fund_valuation_schedule.py +4 -4
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +4 -4
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/futures_contract_details.py +5 -5
- lusid/models/fx_conventions.py +1 -1
- lusid/models/fx_dependency.py +1 -1
- lusid/models/fx_forward.py +6 -6
- lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
- lusid/models/fx_forward_model_options.py +1 -1
- lusid/models/fx_forward_settlement_event.py +6 -6
- lusid/models/fx_forward_tenor_curve_data.py +2 -2
- lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
- lusid/models/fx_forwards_dependency.py +3 -3
- lusid/models/fx_linked_notional_schedule.py +1 -1
- lusid/models/fx_option.py +8 -8
- lusid/models/fx_rate_schedule.py +1 -1
- lusid/models/fx_swap.py +2 -2
- lusid/models/fx_tenor_convention.py +1 -1
- lusid/models/fx_vol_dependency.py +2 -2
- lusid/models/get_reference_portfolio_constituents_response.py +1 -1
- lusid/models/group_of_market_data_key_rules.py +2 -2
- lusid/models/holding_context.py +1 -1
- lusid/models/holding_pricing_info.py +2 -2
- lusid/models/index_convention.py +4 -4
- lusid/models/index_projection_dependency.py +2 -2
- lusid/models/industry_classifier.py +1 -1
- lusid/models/inflation_index_conventions.py +4 -4
- lusid/models/inflation_leg.py +5 -5
- lusid/models/inflation_linked_bond.py +6 -6
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/inline_valuation_request.py +6 -6
- lusid/models/inline_valuations_reconciliation_request.py +1 -1
- lusid/models/instrument_capabilities.py +1 -1
- lusid/models/instrument_definition_format.py +2 -2
- lusid/models/instrument_event.py +1 -1
- lusid/models/instrument_leg.py +1 -1
- lusid/models/interest_rate_swap.py +4 -4
- lusid/models/interest_rate_swaption.py +2 -2
- lusid/models/ir_vol_dependency.py +2 -2
- lusid/models/lapse_election.py +1 -1
- lusid/models/leg_definition.py +8 -8
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +3 -3
- lusid/models/lusid_instrument.py +1 -1
- lusid/models/lusid_trade_ticket.py +1 -1
- lusid/models/mark_to_market_conventions.py +1 -1
- lusid/models/market_context.py +4 -4
- lusid/models/market_context_suppliers.py +1 -1
- lusid/models/market_data_key_rule.py +7 -7
- lusid/models/market_data_options.py +1 -1
- lusid/models/market_data_specific_rule.py +6 -6
- lusid/models/market_data_type.py +1 -1
- lusid/models/market_options.py +1 -1
- lusid/models/market_quote.py +1 -1
- lusid/models/mastered_instrument.py +1 -1
- lusid/models/match_criterion.py +1 -1
- lusid/models/maturity_event.py +1 -1
- lusid/models/mbs_coupon_event.py +1 -1
- lusid/models/mbs_interest_deferral_event.py +1 -1
- lusid/models/mbs_interest_shortfall_event.py +1 -1
- lusid/models/mbs_principal_event.py +1 -1
- lusid/models/mbs_principal_write_off_event.py +1 -1
- lusid/models/model_options.py +1 -1
- lusid/models/model_selection.py +1 -1
- lusid/models/opaque_dependency.py +1 -1
- lusid/models/opaque_market_data.py +3 -3
- lusid/models/option_entry.py +1 -1
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_election.py +1 -1
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/optionality_schedule.py +2 -2
- lusid/models/order_flow_configuration.py +1 -1
- lusid/models/partial_closure_constituent.py +3 -3
- lusid/models/portfolio_result_data_key_rule.py +1 -1
- lusid/models/pre_trade_configuration.py +1 -1
- lusid/models/pricing_context.py +3 -3
- lusid/models/pricing_options.py +9 -9
- lusid/models/property_domain.py +1 -1
- lusid/models/property_reference_data_value.py +1 -1
- lusid/models/quote_dependency.py +1 -1
- lusid/models/quote_series_id.py +1 -1
- lusid/models/raw_vendor_event.py +1 -1
- lusid/models/recipe_value.py +1 -1
- lusid/models/reconcile_date_time_rule.py +1 -1
- lusid/models/reconcile_numeric_rule.py +1 -1
- lusid/models/reconcile_string_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- lusid/models/reconciliation_line.py +1 -1
- lusid/models/reconciliation_request.py +3 -3
- lusid/models/reconciliation_rule.py +1 -1
- lusid/models/relative_date_offset.py +2 -2
- lusid/models/repo.py +8 -8
- lusid/models/repo_cash_flow_event.py +4 -4
- lusid/models/repo_partial_closure_event.py +5 -5
- lusid/models/repurchase_offer_event.py +4 -4
- lusid/models/reset_event.py +1 -1
- lusid/models/result_data_key_rule.py +1 -1
- lusid/models/result_data_schema.py +1 -1
- lusid/models/result_key_rule.py +1 -1
- lusid/models/result_value.py +1 -1
- lusid/models/result_value0_d.py +1 -1
- lusid/models/result_value_date_time_offset.py +1 -1
- lusid/models/result_value_decimal.py +1 -1
- lusid/models/result_value_int.py +1 -1
- lusid/models/return_zero_pv_options.py +1 -1
- lusid/models/rounding_convention.py +4 -4
- lusid/models/schedule.py +1 -1
- lusid/models/scrip_dividend_event.py +1 -1
- lusid/models/security_election.py +2 -2
- lusid/models/security_offer_election.py +1 -1
- lusid/models/side_configuration_data.py +1 -1
- lusid/models/side_configuration_data_request.py +1 -1
- lusid/models/simple_cash_flow_loan.py +2 -2
- lusid/models/simple_instrument.py +2 -2
- lusid/models/simple_rounding_convention.py +2 -2
- lusid/models/step_schedule.py +3 -3
- lusid/models/stock_dividend_event.py +1 -1
- lusid/models/structured_result_data.py +1 -1
- lusid/models/swap_cash_flow_event.py +1 -1
- lusid/models/swap_principal_event.py +1 -1
- lusid/models/tender_offer_election.py +1 -1
- lusid/models/term_deposit.py +1 -1
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/time_zone_conventions.py +1 -1
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +3 -3
- lusid/models/transaction_reconciliation_request_v2.py +3 -3
- lusid/models/transaction_settlement_instruction.py +5 -3
- lusid/models/translate_entities_inlined_request.py +1 -1
- lusid/models/translate_entities_request.py +1 -1
- lusid/models/translate_instrument_definitions_request.py +1 -1
- lusid/models/translate_trade_ticket_request.py +1 -1
- lusid/models/translation_input.py +1 -1
- lusid/models/trigger_event.py +1 -1
- lusid/models/typed_resource_id.py +2 -2
- lusid/models/unmatched_holding_method.py +1 -1
- lusid/models/upsert_cds_flow_conventions_request.py +1 -1
- lusid/models/upsert_counterparty_agreement_request.py +1 -1
- lusid/models/upsert_flow_conventions_request.py +1 -1
- lusid/models/upsert_fund_bookmark_request.py +3 -3
- lusid/models/upsert_index_convention_request.py +1 -1
- lusid/models/upsert_quote_request.py +1 -1
- lusid/models/upsert_recipe_request.py +1 -1
- lusid/models/valuation_request.py +5 -5
- lusid/models/valuation_schedule.py +5 -5
- lusid/models/valuations_reconciliation_request.py +2 -2
- lusid/models/vendor_model_rule.py +3 -3
- lusid/models/virtual_document.py +1 -1
- lusid/models/weighted_instrument.py +2 -2
- lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
- {lusid_sdk-2.1.912.dist-info → lusid_sdk-2.1.914.dist-info}/METADATA +3 -3
- {lusid_sdk-2.1.912.dist-info → lusid_sdk-2.1.914.dist-info}/RECORD +333 -333
- {lusid_sdk-2.1.912.dist-info → lusid_sdk-2.1.914.dist-info}/WHEEL +0 -0
lusid/api/allocations_api.py
CHANGED
@@ -70,7 +70,7 @@ class AllocationsApi:
|
|
70
70
|
def delete_allocation(self, scope : Annotated[StrictStr, Field(..., description="The allocation scope.")], code : Annotated[StrictStr, Field(..., description="The allocation's code. This, together with the scope uniquely identifies the allocation to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
71
71
|
"""[EARLY ACCESS] DeleteAllocation: Delete allocation # noqa: E501
|
72
72
|
|
73
|
-
Delete an allocation. Deletion will be valid from the allocation's creation datetime.
|
73
|
+
Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation 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 AllocationsApi:
|
|
103
103
|
def delete_allocation_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The allocation scope.")], code : Annotated[StrictStr, Field(..., description="The allocation's code. This, together with the scope uniquely identifies the allocation to delete.")], **kwargs) -> ApiResponse: # noqa: E501
|
104
104
|
"""[EARLY ACCESS] DeleteAllocation: Delete allocation # noqa: E501
|
105
105
|
|
106
|
-
Delete an allocation. Deletion will be valid from the allocation's creation datetime.
|
106
|
+
Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation 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 AllocationsApi:
|
|
219
219
|
|
220
220
|
|
221
221
|
@overload
|
222
|
-
async def get_allocation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the allocation belongs.")], code : Annotated[StrictStr, Field(..., description="The allocation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Allocations\" domain to decorate onto the allocation.
|
222
|
+
async def get_allocation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the allocation belongs.")], code : Annotated[StrictStr, Field(..., description="The allocation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Allocations\" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/system/Name\".")] = None, **kwargs) -> Allocation: # noqa: E501
|
223
223
|
...
|
224
224
|
|
225
225
|
@overload
|
226
|
-
def get_allocation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the allocation belongs.")], code : Annotated[StrictStr, Field(..., description="The allocation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Allocations\" domain to decorate onto the allocation.
|
226
|
+
def get_allocation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the allocation belongs.")], code : Annotated[StrictStr, Field(..., description="The allocation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Allocations\" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/system/Name\".")] = None, async_req: Optional[bool]=True, **kwargs) -> Allocation: # noqa: E501
|
227
227
|
...
|
228
228
|
|
229
229
|
@validate_arguments
|
230
|
-
def get_allocation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the allocation belongs.")], code : Annotated[StrictStr, Field(..., description="The allocation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Allocations\" domain to decorate onto the allocation.
|
230
|
+
def get_allocation(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the allocation belongs.")], code : Annotated[StrictStr, Field(..., description="The allocation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Allocations\" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Allocation, Awaitable[Allocation]]: # noqa: E501
|
231
231
|
"""[EARLY ACCESS] GetAllocation: Get Allocation # noqa: E501
|
232
232
|
|
233
233
|
Fetch an Allocation matching the provided identifier # noqa: E501
|
@@ -243,7 +243,7 @@ class AllocationsApi:
|
|
243
243
|
:type code: str
|
244
244
|
:param as_at: The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.
|
245
245
|
:type as_at: datetime
|
246
|
-
:param property_keys: A list of property keys from the \"Allocations\" domain to decorate onto the allocation.
|
246
|
+
:param property_keys: A list of property keys from the \"Allocations\" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/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 AllocationsApi:
|
|
264
264
|
return self.get_allocation_with_http_info(scope, code, as_at, property_keys, **kwargs) # noqa: E501
|
265
265
|
|
266
266
|
@validate_arguments
|
267
|
-
def get_allocation_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the allocation belongs.")], code : Annotated[StrictStr, Field(..., description="The allocation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Allocations\" domain to decorate onto the allocation.
|
267
|
+
def get_allocation_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the allocation belongs.")], code : Annotated[StrictStr, Field(..., description="The allocation's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Allocations\" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
268
268
|
"""[EARLY ACCESS] GetAllocation: Get Allocation # noqa: E501
|
269
269
|
|
270
270
|
Fetch an Allocation matching the provided identifier # noqa: E501
|
@@ -280,7 +280,7 @@ class AllocationsApi:
|
|
280
280
|
:type code: str
|
281
281
|
:param as_at: The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.
|
282
282
|
:type as_at: datetime
|
283
|
-
:param property_keys: A list of property keys from the \"Allocations\" domain to decorate onto the allocation.
|
283
|
+
:param property_keys: A list of property keys from the \"Allocations\" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/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 AllocationsApi:
|
|
399
399
|
|
400
400
|
|
401
401
|
@overload
|
402
|
-
async def list_allocations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing allocations from a previous call to list allocations.
|
402
|
+
async def list_allocations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing allocations from a previous call to list allocations. 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 \"Allocations\" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> PagedResourceListOfAllocation: # noqa: E501
|
403
403
|
...
|
404
404
|
|
405
405
|
@overload
|
406
|
-
def list_allocations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing allocations from a previous call to list allocations.
|
406
|
+
def list_allocations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing allocations from a previous call to list allocations. 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 \"Allocations\" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfAllocation: # noqa: E501
|
407
407
|
...
|
408
408
|
|
409
409
|
@validate_arguments
|
410
|
-
def list_allocations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing allocations from a previous call to list allocations.
|
410
|
+
def list_allocations(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing allocations from a previous call to list allocations. 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 \"Allocations\" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfAllocation, Awaitable[PagedResourceListOfAllocation]]: # noqa: E501
|
411
411
|
"""ListAllocations: List Allocations # noqa: E501
|
412
412
|
|
413
413
|
Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). # noqa: E501
|
@@ -419,15 +419,15 @@ class AllocationsApi:
|
|
419
419
|
|
420
420
|
:param as_at: The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.
|
421
421
|
:type as_at: datetime
|
422
|
-
:param page: The pagination token to use to continue listing allocations from a previous call to list allocations.
|
422
|
+
:param page: The pagination token to use to continue listing allocations from a previous call to list allocations. 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 \"Allocations\" domain to decorate onto each allocation.
|
430
|
+
:param property_keys: A list of property keys from the \"Allocations\" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/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 AllocationsApi:
|
|
448
448
|
return self.list_allocations_with_http_info(as_at, page, sort_by, limit, filter, property_keys, **kwargs) # noqa: E501
|
449
449
|
|
450
450
|
@validate_arguments
|
451
|
-
def list_allocations_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing allocations from a previous call to list allocations.
|
451
|
+
def list_allocations_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing allocations from a previous call to list allocations. 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 \"Allocations\" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
452
452
|
"""ListAllocations: List Allocations # noqa: E501
|
453
453
|
|
454
454
|
Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). # noqa: E501
|
@@ -460,15 +460,15 @@ class AllocationsApi:
|
|
460
460
|
|
461
461
|
:param as_at: The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.
|
462
462
|
:type as_at: datetime
|
463
|
-
:param page: The pagination token to use to continue listing allocations from a previous call to list allocations.
|
463
|
+
:param page: The pagination token to use to continue listing allocations from a previous call to list allocations. 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 \"Allocations\" domain to decorate onto each allocation.
|
471
|
+
:param property_keys: A list of property keys from the \"Allocations\" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/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
|
@@ -596,15 +596,15 @@ class AllocationsApi:
|
|
596
596
|
|
597
597
|
|
598
598
|
@overload
|
599
|
-
async def upsert_allocations(self, allocation_set_request : Annotated[AllocationSetRequest, Field(..., description="The collection of allocation requests.")], verification_as_at : Annotated[Optional[datetime], Field(description="An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.")] = None, retry_without_changed_entities : Annotated[Optional[StrictBool], Field(description="Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have
|
599
|
+
async def upsert_allocations(self, allocation_set_request : Annotated[AllocationSetRequest, Field(..., description="The collection of allocation requests.")], verification_as_at : Annotated[Optional[datetime], Field(description="An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.")] = None, retry_without_changed_entities : Annotated[Optional[StrictBool], Field(description="Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted.")] = None, **kwargs) -> ResourceListOfAllocation: # noqa: E501
|
600
600
|
...
|
601
601
|
|
602
602
|
@overload
|
603
|
-
def upsert_allocations(self, allocation_set_request : Annotated[AllocationSetRequest, Field(..., description="The collection of allocation requests.")], verification_as_at : Annotated[Optional[datetime], Field(description="An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.")] = None, retry_without_changed_entities : Annotated[Optional[StrictBool], Field(description="Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have
|
603
|
+
def upsert_allocations(self, allocation_set_request : Annotated[AllocationSetRequest, Field(..., description="The collection of allocation requests.")], verification_as_at : Annotated[Optional[datetime], Field(description="An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.")] = None, retry_without_changed_entities : Annotated[Optional[StrictBool], Field(description="Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfAllocation: # noqa: E501
|
604
604
|
...
|
605
605
|
|
606
606
|
@validate_arguments
|
607
|
-
def upsert_allocations(self, allocation_set_request : Annotated[AllocationSetRequest, Field(..., description="The collection of allocation requests.")], verification_as_at : Annotated[Optional[datetime], Field(description="An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.")] = None, retry_without_changed_entities : Annotated[Optional[StrictBool], Field(description="Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have
|
607
|
+
def upsert_allocations(self, allocation_set_request : Annotated[AllocationSetRequest, Field(..., description="The collection of allocation requests.")], verification_as_at : Annotated[Optional[datetime], Field(description="An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.")] = None, retry_without_changed_entities : Annotated[Optional[StrictBool], Field(description="Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAllocation, Awaitable[ResourceListOfAllocation]]: # noqa: E501
|
608
608
|
"""UpsertAllocations: Upsert Allocations # noqa: E501
|
609
609
|
|
610
610
|
Upsert; update existing allocations with given ids, or create new allocations otherwise. # noqa: E501
|
@@ -618,7 +618,7 @@ class AllocationsApi:
|
|
618
618
|
:type allocation_set_request: AllocationSetRequest
|
619
619
|
:param verification_as_at: An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.
|
620
620
|
:type verification_as_at: datetime
|
621
|
-
:param retry_without_changed_entities: Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have
|
621
|
+
:param retry_without_changed_entities: Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted.
|
622
622
|
:type retry_without_changed_entities: bool
|
623
623
|
:param async_req: Whether to execute the request asynchronously.
|
624
624
|
:type async_req: bool, optional
|
@@ -639,7 +639,7 @@ class AllocationsApi:
|
|
639
639
|
return self.upsert_allocations_with_http_info(allocation_set_request, verification_as_at, retry_without_changed_entities, **kwargs) # noqa: E501
|
640
640
|
|
641
641
|
@validate_arguments
|
642
|
-
def upsert_allocations_with_http_info(self, allocation_set_request : Annotated[AllocationSetRequest, Field(..., description="The collection of allocation requests.")], verification_as_at : Annotated[Optional[datetime], Field(description="An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.")] = None, retry_without_changed_entities : Annotated[Optional[StrictBool], Field(description="Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have
|
642
|
+
def upsert_allocations_with_http_info(self, allocation_set_request : Annotated[AllocationSetRequest, Field(..., description="The collection of allocation requests.")], verification_as_at : Annotated[Optional[datetime], Field(description="An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.")] = None, retry_without_changed_entities : Annotated[Optional[StrictBool], Field(description="Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
643
643
|
"""UpsertAllocations: Upsert Allocations # noqa: E501
|
644
644
|
|
645
645
|
Upsert; update existing allocations with given ids, or create new allocations otherwise. # noqa: E501
|
@@ -653,7 +653,7 @@ class AllocationsApi:
|
|
653
653
|
:type allocation_set_request: AllocationSetRequest
|
654
654
|
:param verification_as_at: An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert.
|
655
655
|
:type verification_as_at: datetime
|
656
|
-
:param retry_without_changed_entities: Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have
|
656
|
+
:param retry_without_changed_entities: Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted.
|
657
657
|
:type retry_without_changed_entities: bool
|
658
658
|
:param async_req: Whether to execute the request asynchronously.
|
659
659
|
:type async_req: bool, optional
|
@@ -71,7 +71,7 @@ class AmortisationRuleSetsApi:
|
|
71
71
|
def create_amortisation_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The scope of the rule set.")], create_amortisation_rule_set_request : Annotated[CreateAmortisationRuleSetRequest, Field(..., description="The contents of the rule set.")], async_req: Optional[bool]=None, **kwargs) -> Union[AmortisationRuleSet, Awaitable[AmortisationRuleSet]]: # noqa: E501
|
72
72
|
"""[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. # noqa: E501
|
73
73
|
|
74
|
-
Creates an amortisation rule set definition at the given effective time.
|
74
|
+
Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. # noqa: E501
|
75
75
|
This method makes a synchronous HTTP request by default. To make an
|
76
76
|
asynchronous HTTP request, please pass async_req=True
|
77
77
|
|
@@ -104,7 +104,7 @@ class AmortisationRuleSetsApi:
|
|
104
104
|
def create_amortisation_rule_set_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the rule set.")], create_amortisation_rule_set_request : Annotated[CreateAmortisationRuleSetRequest, Field(..., description="The contents of the rule set.")], **kwargs) -> ApiResponse: # noqa: E501
|
105
105
|
"""[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. # noqa: E501
|
106
106
|
|
107
|
-
Creates an amortisation rule set definition at the given effective time.
|
107
|
+
Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. # noqa: E501
|
108
108
|
This method makes a synchronous HTTP request by default. To make an
|
109
109
|
asynchronous HTTP request, please pass async_req=True
|
110
110
|
|
@@ -238,7 +238,7 @@ class AmortisationRuleSetsApi:
|
|
238
238
|
def delete_amortisation_ruleset(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
239
239
|
"""[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. # noqa: E501
|
240
240
|
|
241
|
-
Deletes the rule set perpetually, including its rules.
|
241
|
+
Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone. # noqa: E501
|
242
242
|
This method makes a synchronous HTTP request by default. To make an
|
243
243
|
asynchronous HTTP request, please pass async_req=True
|
244
244
|
|
@@ -271,7 +271,7 @@ class AmortisationRuleSetsApi:
|
|
271
271
|
def delete_amortisation_ruleset_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], **kwargs) -> ApiResponse: # noqa: E501
|
272
272
|
"""[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. # noqa: E501
|
273
273
|
|
274
|
-
Deletes the rule set perpetually, including its rules.
|
274
|
+
Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone. # noqa: E501
|
275
275
|
This method makes a synchronous HTTP request by default. To make an
|
276
276
|
asynchronous HTTP request, please pass async_req=True
|
277
277
|
|
@@ -387,15 +387,15 @@ class AmortisationRuleSetsApi:
|
|
387
387
|
|
388
388
|
|
389
389
|
@overload
|
390
|
-
async def get_amortisation_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition.
|
390
|
+
async def get_amortisation_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule 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 rule definition. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> AmortisationRuleSet: # noqa: E501
|
391
391
|
...
|
392
392
|
|
393
393
|
@overload
|
394
|
-
def get_amortisation_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition.
|
394
|
+
def get_amortisation_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule 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 rule definition. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> AmortisationRuleSet: # noqa: E501
|
395
395
|
...
|
396
396
|
|
397
397
|
@validate_arguments
|
398
|
-
def get_amortisation_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition.
|
398
|
+
def get_amortisation_rule_set(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule 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 rule definition. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AmortisationRuleSet, Awaitable[AmortisationRuleSet]]: # noqa: E501
|
399
399
|
"""[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set # noqa: E501
|
400
400
|
|
401
401
|
Retrieves the amortisation rule set definition at the given effective and as at times. # noqa: E501
|
@@ -409,9 +409,9 @@ class AmortisationRuleSetsApi:
|
|
409
409
|
:type scope: str
|
410
410
|
:param code: The rule set code. (required)
|
411
411
|
:type code: str
|
412
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition.
|
412
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
|
413
413
|
:type effective_at: str
|
414
|
-
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not
|
414
|
+
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.
|
415
415
|
:type as_at: datetime
|
416
416
|
:param async_req: Whether to execute the request asynchronously.
|
417
417
|
:type async_req: bool, optional
|
@@ -432,7 +432,7 @@ class AmortisationRuleSetsApi:
|
|
432
432
|
return self.get_amortisation_rule_set_with_http_info(scope, code, effective_at, as_at, **kwargs) # noqa: E501
|
433
433
|
|
434
434
|
@validate_arguments
|
435
|
-
def get_amortisation_rule_set_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition.
|
435
|
+
def get_amortisation_rule_set_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The rule set scope.")], code : Annotated[StrictStr, Field(..., description="The rule set code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule 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 rule definition. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
436
436
|
"""[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set # noqa: E501
|
437
437
|
|
438
438
|
Retrieves the amortisation rule set definition at the given effective and as at times. # noqa: E501
|
@@ -446,9 +446,9 @@ class AmortisationRuleSetsApi:
|
|
446
446
|
:type scope: str
|
447
447
|
:param code: The rule set code. (required)
|
448
448
|
:type code: str
|
449
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition.
|
449
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
|
450
450
|
:type effective_at: str
|
451
|
-
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not
|
451
|
+
:param as_at: The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.
|
452
452
|
:type as_at: datetime
|
453
453
|
:param async_req: Whether to execute the request asynchronously.
|
454
454
|
:type async_req: bool, optional
|
@@ -566,15 +566,15 @@ class AmortisationRuleSetsApi:
|
|
566
566
|
|
567
567
|
|
568
568
|
@overload
|
569
|
-
async def list_amortisation_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions.
|
569
|
+
async def list_amortisation_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. 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 rule definitions. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing AmortisationRuleSets; 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 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) -> PagedResourceListOfAmortisationRuleSet: # noqa: E501
|
570
570
|
...
|
571
571
|
|
572
572
|
@overload
|
573
|
-
def list_amortisation_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions.
|
573
|
+
def list_amortisation_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. 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 rule definitions. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing AmortisationRuleSets; 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 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) -> PagedResourceListOfAmortisationRuleSet: # noqa: E501
|
574
574
|
...
|
575
575
|
|
576
576
|
@validate_arguments
|
577
|
-
def list_amortisation_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions.
|
577
|
+
def list_amortisation_rule_sets(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. 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 rule definitions. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing AmortisationRuleSets; 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 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[PagedResourceListOfAmortisationRuleSet, Awaitable[PagedResourceListOfAmortisationRuleSet]]: # noqa: E501
|
578
578
|
"""[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. # noqa: E501
|
579
579
|
|
580
580
|
Retrieves all amortisation rule sets at the given effective and as at times # noqa: E501
|
@@ -584,15 +584,15 @@ class AmortisationRuleSetsApi:
|
|
584
584
|
>>> thread = api.list_amortisation_rule_sets(effective_at, as_at, page, limit, filter, sort_by, async_req=True)
|
585
585
|
>>> result = thread.get()
|
586
586
|
|
587
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions.
|
587
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
|
588
588
|
:type effective_at: str
|
589
|
-
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not
|
589
|
+
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
|
590
590
|
:type as_at: datetime
|
591
|
-
:param page: The pagination token to use to continue listing AmortisationRuleSets; this
|
591
|
+
:param page: The pagination token to use to continue listing AmortisationRuleSets; 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.
|
592
592
|
:type page: str
|
593
593
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
594
594
|
:type limit: int
|
595
|
-
:param filter: Expression to filter the results.
|
595
|
+
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
596
596
|
:type filter: str
|
597
597
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
598
598
|
:type sort_by: List[str]
|
@@ -615,7 +615,7 @@ class AmortisationRuleSetsApi:
|
|
615
615
|
return self.list_amortisation_rule_sets_with_http_info(effective_at, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
616
616
|
|
617
617
|
@validate_arguments
|
618
|
-
def list_amortisation_rule_sets_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions.
|
618
|
+
def list_amortisation_rule_sets_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. 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 rule definitions. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing AmortisationRuleSets; 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 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
|
619
619
|
"""[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. # noqa: E501
|
620
620
|
|
621
621
|
Retrieves all amortisation rule sets at the given effective and as at times # noqa: E501
|
@@ -625,15 +625,15 @@ class AmortisationRuleSetsApi:
|
|
625
625
|
>>> thread = api.list_amortisation_rule_sets_with_http_info(effective_at, as_at, page, limit, filter, sort_by, async_req=True)
|
626
626
|
>>> result = thread.get()
|
627
627
|
|
628
|
-
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions.
|
628
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
|
629
629
|
:type effective_at: str
|
630
|
-
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not
|
630
|
+
:param as_at: The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
|
631
631
|
:type as_at: datetime
|
632
|
-
:param page: The pagination token to use to continue listing AmortisationRuleSets; this
|
632
|
+
:param page: The pagination token to use to continue listing AmortisationRuleSets; 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.
|
633
633
|
:type page: str
|
634
634
|
:param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
|
635
635
|
:type limit: int
|
636
|
-
:param filter: Expression to filter the results.
|
636
|
+
:param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
|
637
637
|
:type filter: str
|
638
638
|
:param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
|
639
639
|
:type sort_by: List[str]
|
@@ -350,15 +350,15 @@ class ApplicationMetadataApi:
|
|
350
350
|
|
351
351
|
|
352
352
|
@overload
|
353
|
-
async def list_access_controlled_resources(self, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
353
|
+
async def list_access_controlled_resources(self, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Application, use \"application eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ResourceListOfAccessControlledResource: # noqa: E501
|
354
354
|
...
|
355
355
|
|
356
356
|
@overload
|
357
|
-
def list_access_controlled_resources(self, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
357
|
+
def list_access_controlled_resources(self, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Application, use \"application eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfAccessControlledResource: # noqa: E501
|
358
358
|
...
|
359
359
|
|
360
360
|
@validate_arguments
|
361
|
-
def list_access_controlled_resources(self, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
361
|
+
def list_access_controlled_resources(self, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Application, use \"application eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAccessControlledResource, Awaitable[ResourceListOfAccessControlledResource]]: # noqa: E501
|
362
362
|
"""ListAccessControlledResources: Get resources available for access control # noqa: E501
|
363
363
|
|
364
364
|
Get the comprehensive set of resources that are available for access control # noqa: E501
|
@@ -368,7 +368,7 @@ class ApplicationMetadataApi:
|
|
368
368
|
>>> thread = api.list_access_controlled_resources(filter, async_req=True)
|
369
369
|
>>> result = thread.get()
|
370
370
|
|
371
|
-
:param filter: Optional. Expression to filter the result set.
|
371
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on the Application, use \"application eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
372
372
|
:type filter: str
|
373
373
|
:param async_req: Whether to execute the request asynchronously.
|
374
374
|
:type async_req: bool, optional
|
@@ -389,7 +389,7 @@ class ApplicationMetadataApi:
|
|
389
389
|
return self.list_access_controlled_resources_with_http_info(filter, **kwargs) # noqa: E501
|
390
390
|
|
391
391
|
@validate_arguments
|
392
|
-
def list_access_controlled_resources_with_http_info(self, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set.
|
392
|
+
def list_access_controlled_resources_with_http_info(self, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Application, use \"application eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
393
393
|
"""ListAccessControlledResources: Get resources available for access control # noqa: E501
|
394
394
|
|
395
395
|
Get the comprehensive set of resources that are available for access control # noqa: E501
|
@@ -399,7 +399,7 @@ class ApplicationMetadataApi:
|
|
399
399
|
>>> thread = api.list_access_controlled_resources_with_http_info(filter, async_req=True)
|
400
400
|
>>> result = thread.get()
|
401
401
|
|
402
|
-
:param filter: Optional. Expression to filter the result set.
|
402
|
+
:param filter: Optional. Expression to filter the result set. For example, to filter on the Application, use \"application eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
403
403
|
:type filter: str
|
404
404
|
:param async_req: Whether to execute the request asynchronously.
|
405
405
|
:type async_req: bool, optional
|