lusid-sdk 2.1.138__py3-none-any.whl → 2.1.143__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.
Potentially problematic release.
This version of lusid-sdk might be problematic. Click here for more details.
- lusid/__init__.py +7 -0
- lusid/api/aggregation_api.py +2 -2
- lusid/api/allocations_api.py +2 -2
- lusid/api/calendars_api.py +6 -6
- lusid/api/complex_market_data_api.py +2 -2
- lusid/api/custom_entities_api.py +6 -6
- lusid/api/entities_api.py +2 -2
- lusid/api/executions_api.py +4 -4
- lusid/api/funds_api.py +5 -5
- lusid/api/instrument_events_api.py +2 -2
- lusid/api/instruments_api.py +4 -4
- lusid/api/legal_entities_api.py +20 -20
- lusid/api/orders_api.py +4 -4
- lusid/api/portfolio_groups_api.py +4 -4
- lusid/api/portfolios_api.py +16 -16
- lusid/api/property_definitions_api.py +2 -2
- lusid/api/quotes_api.py +2 -2
- lusid/api/relationships_api.py +2 -2
- lusid/api/structured_result_data_api.py +6 -6
- lusid/api/transaction_portfolios_api.py +6 -6
- lusid/configuration.py +1 -1
- lusid/extensions/__init__.py +2 -0
- lusid/extensions/configuration_loaders.py +68 -5
- lusid/extensions/file_access_token.py +42 -0
- lusid/models/__init__.py +4 -0
- lusid/models/access_metadata_operation.py +3 -3
- lusid/models/accumulation_event.py +3 -3
- lusid/models/amortisation_event.py +3 -3
- lusid/models/applicable_instrument_event.py +3 -1
- 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/capital_distribution_event.py +3 -3
- lusid/models/cash_dividend_event.py +3 -3
- lusid/models/cash_flow_event.py +3 -3
- lusid/models/close_event.py +3 -3
- lusid/models/deleted_entity_response.py +15 -1
- lusid/models/dividend_option_event.py +3 -3
- lusid/models/dividend_reinvestment_event.py +3 -3
- lusid/models/exercise_event.py +3 -3
- lusid/models/expiry_event.py +3 -3
- lusid/models/fx_forward_settlement_event.py +3 -3
- lusid/models/informational_error_event.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/instrument_event.py +6 -5
- lusid/models/instrument_event_configuration.py +1 -1
- lusid/models/instrument_event_type.py +1 -0
- lusid/models/maturity_event.py +3 -3
- lusid/models/new_instrument.py +85 -0
- lusid/models/open_event.py +3 -3
- lusid/models/operation_type.py +1 -0
- lusid/models/raw_vendor_event.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/spin_off_event.py +140 -0
- lusid/models/staged_modifications_requested_change_interval.py +11 -14
- lusid/models/stock_dividend_event.py +3 -3
- lusid/models/stock_split_event.py +3 -3
- lusid/models/transition_event.py +3 -3
- lusid/models/trigger_event.py +3 -3
- {lusid_sdk-2.1.138.dist-info → lusid_sdk-2.1.143.dist-info}/METADATA +56 -54
- {lusid_sdk-2.1.138.dist-info → lusid_sdk-2.1.143.dist-info}/RECORD +64 -61
- {lusid_sdk-2.1.138.dist-info → lusid_sdk-2.1.143.dist-info}/WHEEL +0 -0
lusid/__init__.py
CHANGED
|
@@ -563,6 +563,7 @@ from lusid.models.move_orders_to_different_blocks_request import MoveOrdersToDif
|
|
|
563
563
|
from lusid.models.moved_order_to_different_block_response import MovedOrderToDifferentBlockResponse
|
|
564
564
|
from lusid.models.movement_type import MovementType
|
|
565
565
|
from lusid.models.multi_currency_amounts import MultiCurrencyAmounts
|
|
566
|
+
from lusid.models.new_instrument import NewInstrument
|
|
566
567
|
from lusid.models.next_value_in_sequence_response import NextValueInSequenceResponse
|
|
567
568
|
from lusid.models.numeric_comparison_type import NumericComparisonType
|
|
568
569
|
from lusid.models.opaque_dependency import OpaqueDependency
|
|
@@ -898,6 +899,7 @@ from lusid.models.sides_definition_request import SidesDefinitionRequest
|
|
|
898
899
|
from lusid.models.simple_cash_flow_loan import SimpleCashFlowLoan
|
|
899
900
|
from lusid.models.simple_instrument import SimpleInstrument
|
|
900
901
|
from lusid.models.sort_order import SortOrder
|
|
902
|
+
from lusid.models.spin_off_event import SpinOffEvent
|
|
901
903
|
from lusid.models.staged_modification import StagedModification
|
|
902
904
|
from lusid.models.staged_modification_decision import StagedModificationDecision
|
|
903
905
|
from lusid.models.staged_modification_decision_request import StagedModificationDecisionRequest
|
|
@@ -1083,6 +1085,7 @@ from lusid.extensions import (
|
|
|
1083
1085
|
ConfigurationLoader,
|
|
1084
1086
|
SecretsFileConfigurationLoader,
|
|
1085
1087
|
EnvironmentVariablesConfigurationLoader,
|
|
1088
|
+
FileTokenConfigurationLoader,
|
|
1086
1089
|
ArgsConfigurationLoader,
|
|
1087
1090
|
SyncApiClient
|
|
1088
1091
|
)
|
|
@@ -1625,6 +1628,7 @@ __all__ = [
|
|
|
1625
1628
|
"MovedOrderToDifferentBlockResponse",
|
|
1626
1629
|
"MovementType",
|
|
1627
1630
|
"MultiCurrencyAmounts",
|
|
1631
|
+
"NewInstrument",
|
|
1628
1632
|
"NextValueInSequenceResponse",
|
|
1629
1633
|
"NumericComparisonType",
|
|
1630
1634
|
"OpaqueDependency",
|
|
@@ -1960,6 +1964,7 @@ __all__ = [
|
|
|
1960
1964
|
"SimpleCashFlowLoan",
|
|
1961
1965
|
"SimpleInstrument",
|
|
1962
1966
|
"SortOrder",
|
|
1967
|
+
"SpinOffEvent",
|
|
1963
1968
|
"StagedModification",
|
|
1964
1969
|
"StagedModificationDecision",
|
|
1965
1970
|
"StagedModificationDecisionRequest",
|
|
@@ -2149,6 +2154,8 @@ __all__ = [
|
|
|
2149
2154
|
"ConfigurationLoader",
|
|
2150
2155
|
"SecretsFileConfigurationLoader",
|
|
2151
2156
|
"EnvironmentVariablesConfigurationLoader",
|
|
2157
|
+
"FileTokenConfigurationLoader",
|
|
2152
2158
|
"ArgsConfigurationLoader",
|
|
2153
2159
|
"SyncApiClient"
|
|
2160
|
+
|
|
2154
2161
|
]
|
lusid/api/aggregation_api.py
CHANGED
|
@@ -235,7 +235,7 @@ class AggregationApi:
|
|
|
235
235
|
|
|
236
236
|
@validate_arguments
|
|
237
237
|
def get_queryable_keys(self, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[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, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAggregationQuery, Awaitable[ResourceListOfAggregationQuery]]: # noqa: E501
|
|
238
|
-
"""
|
|
238
|
+
"""GetQueryableKeys: Query the set of supported \"addresses\" that can be queried from the aggregation endpoint. # noqa: E501
|
|
239
239
|
|
|
240
240
|
When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return. # noqa: E501
|
|
241
241
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -271,7 +271,7 @@ class AggregationApi:
|
|
|
271
271
|
|
|
272
272
|
@validate_arguments
|
|
273
273
|
def get_queryable_keys_with_http_info(self, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[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, **kwargs) -> ApiResponse: # noqa: E501
|
|
274
|
-
"""
|
|
274
|
+
"""GetQueryableKeys: Query the set of supported \"addresses\" that can be queried from the aggregation endpoint. # noqa: E501
|
|
275
275
|
|
|
276
276
|
When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return. # noqa: E501
|
|
277
277
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/allocations_api.py
CHANGED
|
@@ -596,7 +596,7 @@ class AllocationsApi:
|
|
|
596
596
|
|
|
597
597
|
@validate_arguments
|
|
598
598
|
def upsert_allocations(self, allocation_set_request : Annotated[Optional[AllocationSetRequest], Field(description="The collection of allocation requests.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAllocation, Awaitable[ResourceListOfAllocation]]: # noqa: E501
|
|
599
|
-
"""
|
|
599
|
+
"""UpsertAllocations: Upsert Allocations # noqa: E501
|
|
600
600
|
|
|
601
601
|
Upsert; update existing allocations with given ids, or create new allocations otherwise. # noqa: E501
|
|
602
602
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -628,7 +628,7 @@ class AllocationsApi:
|
|
|
628
628
|
|
|
629
629
|
@validate_arguments
|
|
630
630
|
def upsert_allocations_with_http_info(self, allocation_set_request : Annotated[Optional[AllocationSetRequest], Field(description="The collection of allocation requests.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
631
|
-
"""
|
|
631
|
+
"""UpsertAllocations: Upsert Allocations # noqa: E501
|
|
632
632
|
|
|
633
633
|
Upsert; update existing allocations with given ids, or create new allocations otherwise. # noqa: E501
|
|
634
634
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/calendars_api.py
CHANGED
|
@@ -234,7 +234,7 @@ class CalendarsApi:
|
|
|
234
234
|
|
|
235
235
|
@validate_arguments
|
|
236
236
|
def add_date_to_calendar(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the calendar")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the calendar")], create_date_request : Annotated[CreateDateRequest, Field(..., description="Add date to calendar request")], async_req: Optional[bool]=None, **kwargs) -> Union[CalendarDate, Awaitable[CalendarDate]]: # noqa: E501
|
|
237
|
-
"""
|
|
237
|
+
"""AddDateToCalendar: Add a date to a calendar # noqa: E501
|
|
238
238
|
|
|
239
239
|
Add an event to the calendar. These Events can be a maximum of 24 hours and must be specified in UTC. A local date will be calculated by the system and applied to the calendar before processing. # noqa: E501
|
|
240
240
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -270,7 +270,7 @@ class CalendarsApi:
|
|
|
270
270
|
|
|
271
271
|
@validate_arguments
|
|
272
272
|
def add_date_to_calendar_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the calendar")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the calendar")], create_date_request : Annotated[CreateDateRequest, Field(..., description="Add date to calendar request")], **kwargs) -> ApiResponse: # noqa: E501
|
|
273
|
-
"""
|
|
273
|
+
"""AddDateToCalendar: Add a date to a calendar # noqa: E501
|
|
274
274
|
|
|
275
275
|
Add an event to the calendar. These Events can be a maximum of 24 hours and must be specified in UTC. A local date will be calculated by the system and applied to the calendar before processing. # noqa: E501
|
|
276
276
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1069,7 +1069,7 @@ class CalendarsApi:
|
|
|
1069
1069
|
|
|
1070
1070
|
@validate_arguments
|
|
1071
1071
|
def get_calendar(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the calendar identifier")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".")] = None, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendar")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Calendar, Awaitable[Calendar]]: # noqa: E501
|
|
1072
|
-
"""
|
|
1072
|
+
"""GetCalendar: Get a calendar in its generic form # noqa: E501
|
|
1073
1073
|
|
|
1074
1074
|
Retrieve a generic calendar by a specific ID at a point in AsAt time # noqa: E501
|
|
1075
1075
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1107,7 +1107,7 @@ class CalendarsApi:
|
|
|
1107
1107
|
|
|
1108
1108
|
@validate_arguments
|
|
1109
1109
|
def get_calendar_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the calendar identifier")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the calendar identifier")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".")] = None, as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendar")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1110
|
-
"""
|
|
1110
|
+
"""GetCalendar: Get a calendar in its generic form # noqa: E501
|
|
1111
1111
|
|
|
1112
1112
|
Retrieve a generic calendar by a specific ID at a point in AsAt time # noqa: E501
|
|
1113
1113
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1811,7 +1811,7 @@ class CalendarsApi:
|
|
|
1811
1811
|
|
|
1812
1812
|
@validate_arguments
|
|
1813
1813
|
def list_calendars_in_scope(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, 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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".")] = 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, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCalendar, Awaitable[PagedResourceListOfCalendar]]: # noqa: E501
|
|
1814
|
-
"""
|
|
1814
|
+
"""ListCalendarsInScope: List all calenders in a specified scope # noqa: E501
|
|
1815
1815
|
|
|
1816
1816
|
List calendars in a Scope at a point in AsAt time. # noqa: E501
|
|
1817
1817
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1853,7 +1853,7 @@ class CalendarsApi:
|
|
|
1853
1853
|
|
|
1854
1854
|
@validate_arguments
|
|
1855
1855
|
def list_calendars_in_scope_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the calendars")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the calendars")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, 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.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Calendar\" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".")] = 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, **kwargs) -> ApiResponse: # noqa: E501
|
|
1856
|
-
"""
|
|
1856
|
+
"""ListCalendarsInScope: List all calenders in a specified scope # noqa: E501
|
|
1857
1857
|
|
|
1858
1858
|
List calendars in a Scope at a point in AsAt time. # noqa: E501
|
|
1859
1859
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -576,7 +576,7 @@ class ComplexMarketDataApi:
|
|
|
576
576
|
|
|
577
577
|
@validate_arguments
|
|
578
578
|
def upsert_complex_market_data(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to use when updating or inserting the complex market data.")], request_body : Annotated[Dict[str, UpsertComplexMarketDataRequest], Field(..., description="The set of complex market data items to update or insert keyed by a unique correlation id.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertStructuredDataResponse, Awaitable[UpsertStructuredDataResponse]]: # noqa: E501
|
|
579
|
-
"""
|
|
579
|
+
"""UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. # noqa: E501
|
|
580
580
|
|
|
581
581
|
Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. # noqa: E501
|
|
582
582
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -610,7 +610,7 @@ class ComplexMarketDataApi:
|
|
|
610
610
|
|
|
611
611
|
@validate_arguments
|
|
612
612
|
def upsert_complex_market_data_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to use when updating or inserting the complex market data.")], request_body : Annotated[Dict[str, UpsertComplexMarketDataRequest], Field(..., description="The set of complex market data items to update or insert keyed by a unique correlation id.")], **kwargs) -> ApiResponse: # noqa: E501
|
|
613
|
-
"""
|
|
613
|
+
"""UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. # noqa: E501
|
|
614
614
|
|
|
615
615
|
Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. # noqa: E501
|
|
616
616
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/custom_entities_api.py
CHANGED
|
@@ -637,7 +637,7 @@ class CustomEntitiesApi:
|
|
|
637
637
|
|
|
638
638
|
@validate_arguments
|
|
639
639
|
def get_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustomEntityResponse, Awaitable[CustomEntityResponse]]: # noqa: E501
|
|
640
|
-
"""
|
|
640
|
+
"""GetCustomEntity: Get a Custom Entity instance. # noqa: E501
|
|
641
641
|
|
|
642
642
|
Retrieve a Custom Entity instance by a specific entity type at a point in AsAt time. # noqa: E501
|
|
643
643
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -683,7 +683,7 @@ class CustomEntitiesApi:
|
|
|
683
683
|
|
|
684
684
|
@validate_arguments
|
|
685
685
|
def get_custom_entity_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[constr(strict=True, max_length=1024, min_length=1), Field(..., description="The identifier value.")], identifier_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
686
|
-
"""
|
|
686
|
+
"""GetCustomEntity: Get a Custom Entity instance. # noqa: E501
|
|
687
687
|
|
|
688
688
|
Retrieve a Custom Entity instance by a specific entity type at a point in AsAt time. # noqa: E501
|
|
689
689
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1262,7 +1262,7 @@ class CustomEntitiesApi:
|
|
|
1262
1262
|
|
|
1263
1263
|
@validate_arguments
|
|
1264
1264
|
def list_custom_entities(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. 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 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, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing entities; 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, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCustomEntityResponse, Awaitable[PagedResourceListOfCustomEntityResponse]]: # noqa: E501
|
|
1265
|
-
"""
|
|
1265
|
+
"""ListCustomEntities: List Custom Entities of the specified entityType. # noqa: E501
|
|
1266
1266
|
|
|
1267
1267
|
List all the Custom Entities matching particular criteria. # noqa: E501
|
|
1268
1268
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1310,7 +1310,7 @@ class CustomEntitiesApi:
|
|
|
1310
1310
|
|
|
1311
1311
|
@validate_arguments
|
|
1312
1312
|
def list_custom_entities_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. 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 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, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing entities; 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, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1313
|
-
"""
|
|
1313
|
+
"""ListCustomEntities: List Custom Entities of the specified entityType. # noqa: E501
|
|
1314
1314
|
|
|
1315
1315
|
List all the Custom Entities matching particular criteria. # noqa: E501
|
|
1316
1316
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1866,7 +1866,7 @@ class CustomEntitiesApi:
|
|
|
1866
1866
|
|
|
1867
1867
|
@validate_arguments
|
|
1868
1868
|
def upsert_custom_entity(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], custom_entity_request : Annotated[CustomEntityRequest, Field(..., description="The payload describing the Custom Entity instance.")], async_req: Optional[bool]=None, **kwargs) -> Union[CustomEntityResponse, Awaitable[CustomEntityResponse]]: # noqa: E501
|
|
1869
|
-
"""
|
|
1869
|
+
"""UpsertCustomEntity: Upsert a Custom Entity instance # noqa: E501
|
|
1870
1870
|
|
|
1871
1871
|
Insert the Custom Entity if it does not exist or update the Custom Entity with the supplied state if it does exist. # noqa: E501
|
|
1872
1872
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1900,7 +1900,7 @@ class CustomEntitiesApi:
|
|
|
1900
1900
|
|
|
1901
1901
|
@validate_arguments
|
|
1902
1902
|
def upsert_custom_entity_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=65, min_length=1), Field(..., description="The type of the Custom Entity to be created. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], custom_entity_request : Annotated[CustomEntityRequest, Field(..., description="The payload describing the Custom Entity instance.")], **kwargs) -> ApiResponse: # noqa: E501
|
|
1903
|
-
"""
|
|
1903
|
+
"""UpsertCustomEntity: Upsert a Custom Entity instance # noqa: E501
|
|
1904
1904
|
|
|
1905
1905
|
Insert the Custom Entity if it does not exist or update the Custom Entity with the supplied state if it does exist. # noqa: E501
|
|
1906
1906
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/entities_api.py
CHANGED
|
@@ -229,7 +229,7 @@ class EntitiesApi:
|
|
|
229
229
|
|
|
230
230
|
@validate_arguments
|
|
231
231
|
def get_portfolio_changes(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope")], effective_at : Annotated[constr(strict=True, max_length=256, min_length=0), Field(..., description="The effective date of the origin.")], as_at : Annotated[Optional[datetime], Field(description="The as-at date of the origin.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfChange, Awaitable[ResourceListOfChange]]: # noqa: E501
|
|
232
|
-
"""
|
|
232
|
+
"""GetPortfolioChanges: Get the next change to each portfolio in a scope. # noqa: E501
|
|
233
233
|
|
|
234
234
|
Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). # noqa: E501
|
|
235
235
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -265,7 +265,7 @@ class EntitiesApi:
|
|
|
265
265
|
|
|
266
266
|
@validate_arguments
|
|
267
267
|
def get_portfolio_changes_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope")], effective_at : Annotated[constr(strict=True, max_length=256, min_length=0), Field(..., description="The effective date of the origin.")], as_at : Annotated[Optional[datetime], Field(description="The as-at date of the origin.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
268
|
-
"""
|
|
268
|
+
"""GetPortfolioChanges: Get the next change to each portfolio in a scope. # noqa: E501
|
|
269
269
|
|
|
270
270
|
Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). # noqa: E501
|
|
271
271
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/executions_api.py
CHANGED
|
@@ -400,7 +400,7 @@ class ExecutionsApi:
|
|
|
400
400
|
|
|
401
401
|
@validate_arguments
|
|
402
402
|
def list_executions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing execution from a previous call to list executions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfExecution, Awaitable[PagedResourceListOfExecution]]: # noqa: E501
|
|
403
|
-
"""
|
|
403
|
+
"""ListExecutions: List Executions # noqa: E501
|
|
404
404
|
|
|
405
405
|
Fetch the last pre-AsAt date version of each execution in scope (does not fetch the entire history). # noqa: E501
|
|
406
406
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -442,7 +442,7 @@ class ExecutionsApi:
|
|
|
442
442
|
|
|
443
443
|
@validate_arguments
|
|
444
444
|
def list_executions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing execution from a previous call to list executions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many.")] = 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
445
|
-
"""
|
|
445
|
+
"""ListExecutions: List Executions # noqa: E501
|
|
446
446
|
|
|
447
447
|
Fetch the last pre-AsAt date version of each execution in scope (does not fetch the entire history). # noqa: E501
|
|
448
448
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -596,7 +596,7 @@ class ExecutionsApi:
|
|
|
596
596
|
|
|
597
597
|
@validate_arguments
|
|
598
598
|
def upsert_executions(self, execution_set_request : Annotated[Optional[ExecutionSetRequest], Field(description="The collection of execution requests.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfExecution, Awaitable[ResourceListOfExecution]]: # noqa: E501
|
|
599
|
-
"""
|
|
599
|
+
"""UpsertExecutions: Upsert Execution # noqa: E501
|
|
600
600
|
|
|
601
601
|
Upsert; update existing executions with given ids, or create new executions otherwise. # noqa: E501
|
|
602
602
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -628,7 +628,7 @@ class ExecutionsApi:
|
|
|
628
628
|
|
|
629
629
|
@validate_arguments
|
|
630
630
|
def upsert_executions_with_http_info(self, execution_set_request : Annotated[Optional[ExecutionSetRequest], Field(description="The collection of execution requests.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
631
|
-
"""
|
|
631
|
+
"""UpsertExecutions: Upsert Execution # noqa: E501
|
|
632
632
|
|
|
633
633
|
Upsert; update existing executions with given ids, or create new executions otherwise. # noqa: E501
|
|
634
634
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/funds_api.py
CHANGED
|
@@ -403,7 +403,7 @@ class FundsApi:
|
|
|
403
403
|
}
|
|
404
404
|
|
|
405
405
|
return self.api_client.call_api(
|
|
406
|
-
'/api/funds/{scope}/{code}/
|
|
406
|
+
'/api/funds/{scope}/{code}/fees/{feeCode}', 'POST',
|
|
407
407
|
_path_params,
|
|
408
408
|
_query_params,
|
|
409
409
|
_header_params,
|
|
@@ -736,7 +736,7 @@ class FundsApi:
|
|
|
736
736
|
}
|
|
737
737
|
|
|
738
738
|
return self.api_client.call_api(
|
|
739
|
-
'/api/funds/{scope}/{code}/
|
|
739
|
+
'/api/funds/{scope}/{code}/fees/{feeCode}', 'DELETE',
|
|
740
740
|
_path_params,
|
|
741
741
|
_query_params,
|
|
742
742
|
_header_params,
|
|
@@ -1431,7 +1431,7 @@ class FundsApi:
|
|
|
1431
1431
|
}
|
|
1432
1432
|
|
|
1433
1433
|
return self.api_client.call_api(
|
|
1434
|
-
'/api/funds/{scope}/{code}/
|
|
1434
|
+
'/api/funds/{scope}/{code}/fees/{feeCode}', 'GET',
|
|
1435
1435
|
_path_params,
|
|
1436
1436
|
_query_params,
|
|
1437
1437
|
_header_params,
|
|
@@ -2023,7 +2023,7 @@ class FundsApi:
|
|
|
2023
2023
|
}
|
|
2024
2024
|
|
|
2025
2025
|
return self.api_client.call_api(
|
|
2026
|
-
'/api/funds/{scope}/{code}/
|
|
2026
|
+
'/api/funds/{scope}/{code}/fees', 'GET',
|
|
2027
2027
|
_path_params,
|
|
2028
2028
|
_query_params,
|
|
2029
2029
|
_header_params,
|
|
@@ -2409,7 +2409,7 @@ class FundsApi:
|
|
|
2409
2409
|
}
|
|
2410
2410
|
|
|
2411
2411
|
return self.api_client.call_api(
|
|
2412
|
-
'/api/funds/{scope}/{code}/
|
|
2412
|
+
'/api/funds/{scope}/{code}/fees/{feeCode}', 'PATCH',
|
|
2413
2413
|
_path_params,
|
|
2414
2414
|
_query_params,
|
|
2415
2415
|
_header_params,
|
|
@@ -252,7 +252,7 @@ class InstrumentEventsApi:
|
|
|
252
252
|
|
|
253
253
|
@validate_arguments
|
|
254
254
|
def query_bucketed_cash_flows(self, query_bucketed_cash_flows_request : Annotated[Optional[QueryBucketedCashFlowsRequest], Field(description="The Query Information.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BucketedCashFlowResponse, Awaitable[BucketedCashFlowResponse]]: # noqa: E501
|
|
255
|
-
"""
|
|
255
|
+
"""QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
|
|
256
256
|
|
|
257
257
|
Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
|
|
258
258
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -284,7 +284,7 @@ class InstrumentEventsApi:
|
|
|
284
284
|
|
|
285
285
|
@validate_arguments
|
|
286
286
|
def query_bucketed_cash_flows_with_http_info(self, query_bucketed_cash_flows_request : Annotated[Optional[QueryBucketedCashFlowsRequest], Field(description="The Query Information.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
287
|
-
"""
|
|
287
|
+
"""QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
|
|
288
288
|
|
|
289
289
|
Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
|
|
290
290
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/instruments_api.py
CHANGED
|
@@ -260,7 +260,7 @@ class InstrumentsApi:
|
|
|
260
260
|
|
|
261
261
|
@validate_arguments
|
|
262
262
|
def delete_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentResponse, Awaitable[DeleteInstrumentResponse]]: # noqa: E501
|
|
263
|
-
"""
|
|
263
|
+
"""DeleteInstrument: Soft delete a single instrument # noqa: E501
|
|
264
264
|
|
|
265
265
|
Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument. # noqa: E501
|
|
266
266
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -296,7 +296,7 @@ class InstrumentsApi:
|
|
|
296
296
|
|
|
297
297
|
@validate_arguments
|
|
298
298
|
def delete_instrument_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
299
|
-
"""
|
|
299
|
+
"""DeleteInstrument: Soft delete a single instrument # noqa: E501
|
|
300
300
|
|
|
301
301
|
Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument. # noqa: E501
|
|
302
302
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -617,7 +617,7 @@ class InstrumentsApi:
|
|
|
617
617
|
|
|
618
618
|
@validate_arguments
|
|
619
619
|
def delete_instruments(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field(description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentsResponse, Awaitable[DeleteInstrumentsResponse]]: # noqa: E501
|
|
620
|
-
"""
|
|
620
|
+
"""DeleteInstruments: Soft or hard delete multiple instruments # noqa: E501
|
|
621
621
|
|
|
622
622
|
Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000. # noqa: E501
|
|
623
623
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -653,7 +653,7 @@ class InstrumentsApi:
|
|
|
653
653
|
|
|
654
654
|
@validate_arguments
|
|
655
655
|
def delete_instruments_with_http_info(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field(description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
656
|
-
"""
|
|
656
|
+
"""DeleteInstruments: Soft or hard delete multiple instruments # noqa: E501
|
|
657
657
|
|
|
658
658
|
Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000. # noqa: E501
|
|
659
659
|
This method makes a synchronous HTTP request by default. To make an
|