lusid-sdk 2.1.139__py3-none-any.whl → 2.1.141__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/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/models/deleted_entity_response.py +15 -1
- {lusid_sdk-2.1.139.dist-info → lusid_sdk-2.1.141.dist-info}/METADATA +54 -54
- {lusid_sdk-2.1.139.dist-info → lusid_sdk-2.1.141.dist-info}/RECORD +24 -24
- {lusid_sdk-2.1.139.dist-info → lusid_sdk-2.1.141.dist-info}/WHEEL +0 -0
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
|
lusid/api/legal_entities_api.py
CHANGED
|
@@ -72,7 +72,7 @@ class LegalEntitiesApi:
|
|
|
72
72
|
|
|
73
73
|
@validate_arguments
|
|
74
74
|
def delete_legal_entity(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
|
75
|
-
"""
|
|
75
|
+
"""DeleteLegalEntity: Delete Legal Entity # noqa: E501
|
|
76
76
|
|
|
77
77
|
Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
|
78
78
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -108,7 +108,7 @@ class LegalEntitiesApi:
|
|
|
108
108
|
|
|
109
109
|
@validate_arguments
|
|
110
110
|
def delete_legal_entity_with_http_info(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.")], **kwargs) -> ApiResponse: # noqa: E501
|
|
111
|
-
"""
|
|
111
|
+
"""DeleteLegalEntity: Delete Legal Entity # noqa: E501
|
|
112
112
|
|
|
113
113
|
Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
|
114
114
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -801,7 +801,7 @@ class LegalEntitiesApi:
|
|
|
801
801
|
|
|
802
802
|
@validate_arguments
|
|
803
803
|
def get_all_legal_entity_access_metadata(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the Legal Entity identifier.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the Legal Entity identifier.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the Legal Entity under specified identifier type's scope and code.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which to retrieve the Access Metadata")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[AccessMetadataValue]], Awaitable[Dict[str, List[AccessMetadataValue]]]]: # noqa: E501
|
|
804
|
-
"""
|
|
804
|
+
"""GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity # noqa: E501
|
|
805
805
|
|
|
806
806
|
Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata # noqa: E501
|
|
807
807
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -841,7 +841,7 @@ class LegalEntitiesApi:
|
|
|
841
841
|
|
|
842
842
|
@validate_arguments
|
|
843
843
|
def get_all_legal_entity_access_metadata_with_http_info(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the Legal Entity identifier.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the Legal Entity identifier.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the Legal Entity under specified identifier type's scope and code.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which to retrieve the Access Metadata")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
844
|
-
"""
|
|
844
|
+
"""GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity # noqa: E501
|
|
845
845
|
|
|
846
846
|
Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata # noqa: E501
|
|
847
847
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -987,7 +987,7 @@ class LegalEntitiesApi:
|
|
|
987
987
|
|
|
988
988
|
@validate_arguments
|
|
989
989
|
def get_legal_entity(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for found legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to retrieve the legal 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 legal entity. Defaults to return the latest version of the legal entity if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the legal entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[LegalEntity, Awaitable[LegalEntity]]: # noqa: E501
|
|
990
|
-
"""
|
|
990
|
+
"""GetLegalEntity: Get Legal Entity # noqa: E501
|
|
991
991
|
|
|
992
992
|
Retrieve the definition of a legal entity. # noqa: E501
|
|
993
993
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1031,7 +1031,7 @@ class LegalEntitiesApi:
|
|
|
1031
1031
|
|
|
1032
1032
|
@validate_arguments
|
|
1033
1033
|
def get_legal_entity_with_http_info(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for found legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to retrieve the legal 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 legal entity. Defaults to return the latest version of the legal entity if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the legal entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1034
|
-
"""
|
|
1034
|
+
"""GetLegalEntity: Get Legal Entity # noqa: E501
|
|
1035
1035
|
|
|
1036
1036
|
Retrieve the definition of a legal entity. # noqa: E501
|
|
1037
1037
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1385,7 +1385,7 @@ class LegalEntitiesApi:
|
|
|
1385
1385
|
|
|
1386
1386
|
@validate_arguments
|
|
1387
1387
|
def get_legal_entity_property_time_series(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\". Each property must be from the \"LegalEntity\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = 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, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the 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, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
|
|
1388
|
-
"""
|
|
1388
|
+
"""GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series # noqa: E501
|
|
1389
1389
|
|
|
1390
1390
|
List the complete time series of a legal entity property. # noqa: E501
|
|
1391
1391
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1431,7 +1431,7 @@ class LegalEntitiesApi:
|
|
|
1431
1431
|
|
|
1432
1432
|
@validate_arguments
|
|
1433
1433
|
def get_legal_entity_property_time_series_with_http_info(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\". Each property must be from the \"LegalEntity\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = 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, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the 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, **kwargs) -> ApiResponse: # noqa: E501
|
|
1434
|
-
"""
|
|
1434
|
+
"""GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series # noqa: E501
|
|
1435
1435
|
|
|
1436
1436
|
List the complete time series of a legal entity property. # noqa: E501
|
|
1437
1437
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1595,7 +1595,7 @@ class LegalEntitiesApi:
|
|
|
1595
1595
|
|
|
1596
1596
|
@validate_arguments
|
|
1597
1597
|
def get_legal_entity_relations(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relations. 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 legal entity's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the relations. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelation, Awaitable[ResourceListOfRelation]]: # noqa: E501
|
|
1598
|
-
"""
|
|
1598
|
+
"""GetLegalEntityRelations: Get Relations for Legal Entity # noqa: E501
|
|
1599
1599
|
|
|
1600
1600
|
Get relations for the specified Legal Entity # noqa: E501
|
|
1601
1601
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1639,7 +1639,7 @@ class LegalEntitiesApi:
|
|
|
1639
1639
|
|
|
1640
1640
|
@validate_arguments
|
|
1641
1641
|
def get_legal_entity_relations_with_http_info(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relations. 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 legal entity's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the relations. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1642
|
-
"""
|
|
1642
|
+
"""GetLegalEntityRelations: Get Relations for Legal Entity # noqa: E501
|
|
1643
1643
|
|
|
1644
1644
|
Get relations for the specified Legal Entity # noqa: E501
|
|
1645
1645
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1798,7 +1798,7 @@ class LegalEntitiesApi:
|
|
|
1798
1798
|
|
|
1799
1799
|
@validate_arguments
|
|
1800
1800
|
def get_legal_entity_relationships(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity's identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity's identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. 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 relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
|
|
1801
|
-
"""
|
|
1801
|
+
"""GetLegalEntityRelationships: Get Relationships for Legal Entity # noqa: E501
|
|
1802
1802
|
|
|
1803
1803
|
Get Relationships for the specified Legal Entity # noqa: E501
|
|
1804
1804
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1842,7 +1842,7 @@ class LegalEntitiesApi:
|
|
|
1842
1842
|
|
|
1843
1843
|
@validate_arguments
|
|
1844
1844
|
def get_legal_entity_relationships_with_http_info(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity's identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity's identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. 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 relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1845
|
-
"""
|
|
1845
|
+
"""GetLegalEntityRelationships: Get Relationships for Legal Entity # noqa: E501
|
|
1846
1846
|
|
|
1847
1847
|
Get Relationships for the specified Legal Entity # noqa: E501
|
|
1848
1848
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2001,7 +2001,7 @@ class LegalEntitiesApi:
|
|
|
2001
2001
|
|
|
2002
2002
|
@validate_arguments
|
|
2003
2003
|
def list_all_legal_entities(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the legal 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 legal entities. Defaults to return the latest version of each legal entities 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 legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, 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 5000 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 or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfLegalEntity, Awaitable[ResourceListOfLegalEntity]]: # noqa: E501
|
|
2004
|
-
"""
|
|
2004
|
+
"""ListAllLegalEntities: List Legal Entities # noqa: E501
|
|
2005
2005
|
|
|
2006
2006
|
List all legal entities which the user is entitled to see. # noqa: E501
|
|
2007
2007
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2047,7 +2047,7 @@ class LegalEntitiesApi:
|
|
|
2047
2047
|
|
|
2048
2048
|
@validate_arguments
|
|
2049
2049
|
def list_all_legal_entities_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the legal 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 legal entities. Defaults to return the latest version of each legal entities 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 legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, 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 5000 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 or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
2050
|
-
"""
|
|
2050
|
+
"""ListAllLegalEntities: List Legal Entities # noqa: E501
|
|
2051
2051
|
|
|
2052
2052
|
List all legal entities which the user is entitled to see. # noqa: E501
|
|
2053
2053
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2214,7 +2214,7 @@ class LegalEntitiesApi:
|
|
|
2214
2214
|
|
|
2215
2215
|
@validate_arguments
|
|
2216
2216
|
def list_legal_entities(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people 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 legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, 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 or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfLegalEntity, Awaitable[PagedResourceListOfLegalEntity]]: # noqa: E501
|
|
2217
|
-
"""
|
|
2217
|
+
"""ListLegalEntities: List Legal Entities # noqa: E501
|
|
2218
2218
|
|
|
2219
2219
|
List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria. # noqa: E501
|
|
2220
2220
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2264,7 +2264,7 @@ class LegalEntitiesApi:
|
|
|
2264
2264
|
|
|
2265
2265
|
@validate_arguments
|
|
2266
2266
|
def list_legal_entities_with_http_info(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people 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 legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, 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 or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys or identifier types (as property keys) from the \"LegalEntity\" domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"LegalEntity/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
2267
|
-
"""
|
|
2267
|
+
"""ListLegalEntities: List Legal Entities # noqa: E501
|
|
2268
2268
|
|
|
2269
2269
|
List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria. # noqa: E501
|
|
2270
2270
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2826,7 +2826,7 @@ class LegalEntitiesApi:
|
|
|
2826
2826
|
|
|
2827
2827
|
@validate_arguments
|
|
2828
2828
|
def set_legal_entity_properties(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], set_legal_entity_properties_request : Annotated[SetLegalEntityPropertiesRequest, Field(..., description="Request containing properties to set for the legal entity. Properties not specified in request will not be changed.")], async_req: Optional[bool]=None, **kwargs) -> Union[LegalEntity, Awaitable[LegalEntity]]: # noqa: E501
|
|
2829
|
-
"""
|
|
2829
|
+
"""SetLegalEntityProperties: Set Legal Entity Properties # noqa: E501
|
|
2830
2830
|
|
|
2831
2831
|
Set properties of the legal entity. # noqa: E501
|
|
2832
2832
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2864,7 +2864,7 @@ class LegalEntitiesApi:
|
|
|
2864
2864
|
|
|
2865
2865
|
@validate_arguments
|
|
2866
2866
|
def set_legal_entity_properties_with_http_info(self, id_type_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the legal entity identifier type.")], id_type_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity identifier type.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.")], set_legal_entity_properties_request : Annotated[SetLegalEntityPropertiesRequest, Field(..., description="Request containing properties to set for the legal entity. Properties not specified in request will not be changed.")], **kwargs) -> ApiResponse: # noqa: E501
|
|
2867
|
-
"""
|
|
2867
|
+
"""SetLegalEntityProperties: Set Legal Entity Properties # noqa: E501
|
|
2868
2868
|
|
|
2869
2869
|
Set properties of the legal entity. # noqa: E501
|
|
2870
2870
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -3174,7 +3174,7 @@ class LegalEntitiesApi:
|
|
|
3174
3174
|
|
|
3175
3175
|
@validate_arguments
|
|
3176
3176
|
def upsert_legal_entity(self, upsert_legal_entity_request : Annotated[UpsertLegalEntityRequest, Field(..., description="Request to create or update a legal entity.")], async_req: Optional[bool]=None, **kwargs) -> Union[LegalEntity, Awaitable[LegalEntity]]: # noqa: E501
|
|
3177
|
-
"""
|
|
3177
|
+
"""UpsertLegalEntity: Upsert Legal Entity # noqa: E501
|
|
3178
3178
|
|
|
3179
3179
|
Create or update a legal entity # noqa: E501
|
|
3180
3180
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -3206,7 +3206,7 @@ class LegalEntitiesApi:
|
|
|
3206
3206
|
|
|
3207
3207
|
@validate_arguments
|
|
3208
3208
|
def upsert_legal_entity_with_http_info(self, upsert_legal_entity_request : Annotated[UpsertLegalEntityRequest, Field(..., description="Request to create or update a legal entity.")], **kwargs) -> ApiResponse: # noqa: E501
|
|
3209
|
-
"""
|
|
3209
|
+
"""UpsertLegalEntity: Upsert Legal Entity # noqa: E501
|
|
3210
3210
|
|
|
3211
3211
|
Create or update a legal entity # noqa: E501
|
|
3212
3212
|
This method makes a synchronous HTTP request by default. To make an
|