lusid-sdk 2.1.590__py3-none-any.whl → 2.1.637__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/__init__.py +42 -0
- lusid/api/__init__.py +2 -0
- lusid/api/chart_of_accounts_api.py +6 -6
- lusid/api/corporate_action_sources_api.py +6 -6
- lusid/api/entities_api.py +24 -24
- lusid/api/funds_api.py +438 -1
- lusid/api/order_management_api.py +16 -8
- lusid/api/staged_modifications_api.py +12 -12
- lusid/api/timelines_api.py +1094 -0
- lusid/api/transaction_portfolios_api.py +189 -6
- lusid/api/workspace_api.py +96 -48
- lusid/configuration.py +1 -1
- lusid/models/__init__.py +40 -0
- lusid/models/accounted_transaction.py +88 -0
- lusid/models/accumulation_event.py +3 -3
- lusid/models/adjust_global_commitment_event.py +93 -0
- lusid/models/amortisation_event.py +3 -3
- lusid/models/basket.py +3 -3
- lusid/models/bond.py +11 -5
- lusid/models/bond_coupon_event.py +3 -3
- lusid/models/bond_default_event.py +3 -3
- lusid/models/bond_principal_event.py +3 -3
- lusid/models/bonus_issue_event.py +3 -3
- lusid/models/call_on_intermediate_securities_event.py +3 -3
- lusid/models/cancel_single_holding_adjustment_request.py +96 -0
- lusid/models/cap_floor.py +22 -7
- lusid/models/capital_distribution_event.py +3 -3
- lusid/models/cash.py +3 -3
- lusid/models/cash_dividend_event.py +3 -3
- lusid/models/cash_flow_event.py +3 -3
- lusid/models/cash_perpetual.py +3 -3
- lusid/models/cds_credit_event.py +3 -3
- lusid/models/cds_index.py +3 -3
- lusid/models/cdx_credit_event.py +3 -3
- lusid/models/close_event.py +3 -3
- lusid/models/closed_period.py +128 -0
- lusid/models/complete_portfolio.py +3 -3
- lusid/models/complex_bond.py +20 -7
- lusid/models/contract_details.py +101 -0
- lusid/models/contract_for_difference.py +3 -3
- lusid/models/contract_initialisation_event.py +99 -0
- lusid/models/create_closed_period_request.py +96 -0
- lusid/models/create_derived_property_definition_request.py +8 -6
- lusid/models/create_derived_transaction_portfolio_request.py +8 -2
- lusid/models/create_property_definition_request.py +3 -3
- lusid/models/create_timeline_request.py +102 -0
- lusid/models/credit_default_swap.py +3 -3
- lusid/models/credit_premium_cash_flow_event.py +3 -3
- lusid/models/dependency_source_filter.py +19 -4
- lusid/models/dividend_option_event.py +3 -3
- lusid/models/dividend_reinvestment_event.py +3 -3
- lusid/models/drawdown_event.py +99 -0
- lusid/models/early_redemption_event.py +3 -3
- lusid/models/eligibility_calculation.py +6 -4
- lusid/models/equity.py +3 -3
- lusid/models/equity_option.py +29 -8
- lusid/models/equity_swap.py +3 -3
- lusid/models/exchange_traded_option.py +12 -6
- lusid/models/exercise_event.py +3 -3
- lusid/models/exotic_instrument.py +3 -3
- lusid/models/expiry_event.py +3 -3
- lusid/models/fee_accrual.py +3 -1
- lusid/models/fixed_leg.py +3 -3
- lusid/models/flexible_deposit.py +105 -0
- lusid/models/flexible_loan.py +3 -3
- lusid/models/floating_leg.py +3 -3
- lusid/models/forward_rate_agreement.py +3 -3
- lusid/models/fund_share_class.py +3 -3
- lusid/models/funding_leg.py +3 -3
- lusid/models/future.py +19 -7
- lusid/models/future_expiry_event.py +3 -3
- lusid/models/future_mark_to_market_event.py +100 -0
- lusid/models/fx_forward.py +3 -3
- lusid/models/fx_forward_settlement_event.py +3 -3
- lusid/models/fx_option.py +3 -3
- lusid/models/fx_swap.py +3 -3
- lusid/models/group_reconciliation_summary.py +2 -2
- lusid/models/inflation_leg.py +3 -3
- lusid/models/inflation_linked_bond.py +11 -5
- lusid/models/inflation_swap.py +3 -3
- lusid/models/informational_error_event.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/instrument_event.py +10 -5
- lusid/models/instrument_event_instruction.py +9 -2
- lusid/models/instrument_event_instruction_request.py +10 -3
- lusid/models/instrument_event_type.py +5 -0
- lusid/models/instrument_leg.py +3 -3
- lusid/models/instrument_type.py +1 -0
- lusid/models/interest_rate_swap.py +3 -3
- lusid/models/interest_rate_swaption.py +4 -4
- lusid/models/intermediate_securities_distribution_event.py +3 -3
- lusid/models/loan_facility.py +3 -3
- lusid/models/loan_interest_repayment_event.py +97 -0
- lusid/models/lusid_instrument.py +6 -5
- lusid/models/mark_to_market_conventions.py +74 -0
- lusid/models/market_data_key_rule.py +1 -1
- lusid/models/market_data_specific_rule.py +1 -1
- lusid/models/mastered_instrument.py +3 -3
- lusid/models/maturity_event.py +3 -3
- lusid/models/mbs_coupon_event.py +3 -3
- lusid/models/mbs_interest_deferral_event.py +3 -3
- lusid/models/mbs_interest_shortfall_event.py +3 -3
- lusid/models/mbs_principal_event.py +3 -3
- lusid/models/mbs_principal_write_off_event.py +3 -3
- lusid/models/merger_event.py +3 -3
- lusid/models/open_event.py +3 -3
- lusid/models/option_exercise_cash_event.py +3 -3
- lusid/models/option_exercise_physical_event.py +3 -3
- lusid/models/output_transaction.py +7 -1
- lusid/models/pnl_journal_entry_line.py +95 -0
- lusid/models/portfolio.py +3 -3
- lusid/models/portfolio_id.py +80 -0
- lusid/models/portfolio_search_result.py +3 -3
- lusid/models/portfolio_type.py +1 -0
- lusid/models/portfolio_without_href.py +3 -3
- lusid/models/property_definition.py +6 -4
- lusid/models/property_definition_search_result.py +6 -4
- lusid/models/property_domain.py +1 -0
- lusid/models/protection_payout_cash_flow_event.py +3 -3
- lusid/models/raw_vendor_event.py +3 -3
- lusid/models/reference_instrument.py +3 -3
- lusid/models/repo.py +3 -3
- lusid/models/reset_event.py +3 -3
- lusid/models/reverse_stock_split_event.py +3 -3
- lusid/models/scrip_dividend_event.py +3 -3
- lusid/models/side_definition.py +8 -1
- lusid/models/side_definition_request.py +9 -2
- lusid/models/simple_cash_flow_loan.py +3 -3
- lusid/models/simple_instrument.py +3 -3
- lusid/models/spin_off_event.py +3 -3
- lusid/models/stock_dividend_event.py +3 -3
- lusid/models/stock_split_event.py +3 -3
- lusid/models/swap_cash_flow_event.py +3 -3
- lusid/models/swap_principal_event.py +3 -3
- lusid/models/tender_event.py +3 -3
- lusid/models/term_deposit.py +3 -3
- lusid/models/term_deposit_interest_event.py +3 -3
- lusid/models/term_deposit_principal_event.py +3 -3
- lusid/models/timeline.py +135 -0
- lusid/models/total_return_swap.py +3 -3
- lusid/models/trading_conventions.py +73 -0
- lusid/models/transition_event.py +3 -3
- lusid/models/trigger_event.py +3 -3
- lusid/models/update_derived_property_definition_request.py +5 -3
- lusid/models/update_timeline_request.py +96 -0
- lusid/models/valuation_point_resource_list_of_accounted_transaction.py +125 -0
- lusid/models/valuation_point_resource_list_of_pnl_journal_entry_line.py +125 -0
- lusid/models/workspace.py +1 -1
- lusid/models/workspace_creation_request.py +1 -1
- lusid/models/workspace_item.py +4 -2
- lusid/models/workspace_item_creation_request.py +11 -2
- {lusid_sdk-2.1.590.dist-info → lusid_sdk-2.1.637.dist-info}/METADATA +40 -10
- {lusid_sdk-2.1.590.dist-info → lusid_sdk-2.1.637.dist-info}/RECORD +154 -133
- {lusid_sdk-2.1.590.dist-info → lusid_sdk-2.1.637.dist-info}/WHEEL +1 -1
lusid/api/entities_api.py
CHANGED
@@ -56,15 +56,15 @@ class EntitiesApi:
|
|
56
56
|
self.api_client = api_client
|
57
57
|
|
58
58
|
@overload
|
59
|
-
async def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
59
|
+
async def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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) -> CustomEntityEntity: # noqa: E501
|
60
60
|
...
|
61
61
|
|
62
62
|
@overload
|
63
|
-
def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
63
|
+
def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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]=True, **kwargs) -> CustomEntityEntity: # noqa: E501
|
64
64
|
...
|
65
65
|
|
66
66
|
@validate_arguments
|
67
|
-
def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
67
|
+
def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
68
68
|
"""[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
|
69
69
|
|
70
70
|
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
|
@@ -101,7 +101,7 @@ class EntitiesApi:
|
|
101
101
|
return self.get_custom_entity_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, **kwargs) # noqa: E501
|
102
102
|
|
103
103
|
@validate_arguments
|
104
|
-
def get_custom_entity_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
104
|
+
def get_custom_entity_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
105
105
|
"""[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
|
106
106
|
|
107
107
|
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
|
@@ -235,15 +235,15 @@ class EntitiesApi:
|
|
235
235
|
_request_auth=_params.get('_request_auth'))
|
236
236
|
|
237
237
|
@overload
|
238
|
-
async def get_data_type_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
238
|
+
async def get_data_type_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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) -> DataTypeEntity: # noqa: E501
|
239
239
|
...
|
240
240
|
|
241
241
|
@overload
|
242
|
-
def get_data_type_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
242
|
+
def get_data_type_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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]=True, **kwargs) -> DataTypeEntity: # noqa: E501
|
243
243
|
...
|
244
244
|
|
245
245
|
@validate_arguments
|
246
|
-
def get_data_type_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
246
|
+
def get_data_type_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
247
247
|
"""[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
|
248
248
|
|
249
249
|
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
|
@@ -278,7 +278,7 @@ class EntitiesApi:
|
|
278
278
|
return self.get_data_type_by_entity_unique_id_with_http_info(entity_unique_id, as_at, previews, **kwargs) # noqa: E501
|
279
279
|
|
280
280
|
@validate_arguments
|
281
|
-
def get_data_type_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
281
|
+
def get_data_type_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
282
282
|
"""[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
|
283
283
|
|
284
284
|
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
|
@@ -406,15 +406,15 @@ class EntitiesApi:
|
|
406
406
|
_request_auth=_params.get('_request_auth'))
|
407
407
|
|
408
408
|
@overload
|
409
|
-
async def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=
|
409
|
+
async def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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
|
410
410
|
...
|
411
411
|
|
412
412
|
@overload
|
413
|
-
def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=
|
413
|
+
def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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
|
414
414
|
...
|
415
415
|
|
416
416
|
@validate_arguments
|
417
|
-
def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=
|
417
|
+
def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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
|
418
418
|
"""[EXPERIMENTAL] GetEntityHistory: List an entity's history information # noqa: E501
|
419
419
|
|
420
420
|
Retrieve a page of an entity's change history up to a particular point in AsAt time. # noqa: E501
|
@@ -457,7 +457,7 @@ class EntitiesApi:
|
|
457
457
|
return self.get_entity_history_with_http_info(entity_type, entity_unique_id, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
458
458
|
|
459
459
|
@validate_arguments
|
460
|
-
def get_entity_history_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=
|
460
|
+
def get_entity_history_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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[constr(strict=True, max_length=500, min_length=1)], 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, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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
|
461
461
|
"""[EXPERIMENTAL] GetEntityHistory: List an entity's history information # noqa: E501
|
462
462
|
|
463
463
|
Retrieve a page of an entity's change history up to a particular point in AsAt time. # noqa: E501
|
@@ -609,15 +609,15 @@ class EntitiesApi:
|
|
609
609
|
_request_auth=_params.get('_request_auth'))
|
610
610
|
|
611
611
|
@overload
|
612
|
-
async def get_instrument_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
612
|
+
async def get_instrument_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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) -> InstrumentEntity: # noqa: E501
|
613
613
|
...
|
614
614
|
|
615
615
|
@overload
|
616
|
-
def get_instrument_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
616
|
+
def get_instrument_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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]=True, **kwargs) -> InstrumentEntity: # noqa: E501
|
617
617
|
...
|
618
618
|
|
619
619
|
@validate_arguments
|
620
|
-
def get_instrument_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
620
|
+
def get_instrument_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
621
621
|
"""[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
|
622
622
|
|
623
623
|
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
|
@@ -654,7 +654,7 @@ class EntitiesApi:
|
|
654
654
|
return self.get_instrument_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, **kwargs) # noqa: E501
|
655
655
|
|
656
656
|
@validate_arguments
|
657
|
-
def get_instrument_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
657
|
+
def get_instrument_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
658
658
|
"""[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
|
659
659
|
|
660
660
|
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
|
@@ -788,15 +788,15 @@ class EntitiesApi:
|
|
788
788
|
_request_auth=_params.get('_request_auth'))
|
789
789
|
|
790
790
|
@overload
|
791
|
-
async def get_portfolio_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
791
|
+
async def get_portfolio_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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) -> PortfolioEntity: # noqa: E501
|
792
792
|
...
|
793
793
|
|
794
794
|
@overload
|
795
|
-
def get_portfolio_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
795
|
+
def get_portfolio_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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]=True, **kwargs) -> PortfolioEntity: # noqa: E501
|
796
796
|
...
|
797
797
|
|
798
798
|
@validate_arguments
|
799
|
-
def get_portfolio_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
799
|
+
def get_portfolio_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
800
800
|
"""[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
|
801
801
|
|
802
802
|
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
|
@@ -833,7 +833,7 @@ class EntitiesApi:
|
|
833
833
|
return self.get_portfolio_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, **kwargs) # noqa: E501
|
834
834
|
|
835
835
|
@validate_arguments
|
836
|
-
def get_portfolio_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
836
|
+
def get_portfolio_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
837
837
|
"""[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
|
838
838
|
|
839
839
|
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
|
@@ -1137,15 +1137,15 @@ class EntitiesApi:
|
|
1137
1137
|
_request_auth=_params.get('_request_auth'))
|
1138
1138
|
|
1139
1139
|
@overload
|
1140
|
-
async def get_property_definition_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
1140
|
+
async def get_property_definition_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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) -> PropertyDefinitionEntity: # noqa: E501
|
1141
1141
|
...
|
1142
1142
|
|
1143
1143
|
@overload
|
1144
|
-
def get_property_definition_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
1144
|
+
def get_property_definition_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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]=True, **kwargs) -> PropertyDefinitionEntity: # noqa: E501
|
1145
1145
|
...
|
1146
1146
|
|
1147
1147
|
@validate_arguments
|
1148
|
-
def get_property_definition_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
1148
|
+
def get_property_definition_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
1149
1149
|
"""[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
|
1150
1150
|
|
1151
1151
|
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
|
@@ -1182,7 +1182,7 @@ class EntitiesApi:
|
|
1182
1182
|
return self.get_property_definition_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, **kwargs) # noqa: E501
|
1183
1183
|
|
1184
1184
|
@validate_arguments
|
1185
|
-
def get_property_definition_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=
|
1185
|
+
def get_property_definition_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=36, min_length=36), 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
|
1186
1186
|
"""[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
|
1187
1187
|
|
1188
1188
|
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
|