lusid-sdk 2.1.137__py3-none-any.whl → 2.1.149__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 +69 -6
- 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/fee.py +6 -1
- lusid/models/fee_request.py +7 -2
- 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.137.dist-info → lusid_sdk-2.1.149.dist-info}/METADATA +56 -54
- {lusid_sdk-2.1.137.dist-info → lusid_sdk-2.1.149.dist-info}/RECORD +66 -63
- {lusid_sdk-2.1.137.dist-info → lusid_sdk-2.1.149.dist-info}/WHEEL +0 -0
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
|
lusid/api/orders_api.py
CHANGED
|
@@ -400,7 +400,7 @@ class OrdersApi:
|
|
|
400
400
|
|
|
401
401
|
@validate_arguments
|
|
402
402
|
def list_orders(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order 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 orders from a previous call to list orders. 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 \"Orders\" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfOrder, Awaitable[PagedResourceListOfOrder]]: # noqa: E501
|
|
403
|
-
"""
|
|
403
|
+
"""ListOrders: List Orders # noqa: E501
|
|
404
404
|
|
|
405
405
|
Fetch the last pre-AsAt date version of each order with optional filtering (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 OrdersApi:
|
|
|
442
442
|
|
|
443
443
|
@validate_arguments
|
|
444
444
|
def list_orders_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order 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 orders from a previous call to list orders. 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 \"Orders\" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. \"Orders/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
445
|
-
"""
|
|
445
|
+
"""ListOrders: List Orders # noqa: E501
|
|
446
446
|
|
|
447
447
|
Fetch the last pre-AsAt date version of each order with optional filtering (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 OrdersApi:
|
|
|
596
596
|
|
|
597
597
|
@validate_arguments
|
|
598
598
|
def upsert_orders(self, order_set_request : Annotated[Optional[OrderSetRequest], Field(description="The collection of order requests.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfOrder, Awaitable[ResourceListOfOrder]]: # noqa: E501
|
|
599
|
-
"""
|
|
599
|
+
"""UpsertOrders: Upsert Order # noqa: E501
|
|
600
600
|
|
|
601
601
|
Upsert; update existing orders with given ids, or create new orders otherwise. # noqa: E501
|
|
602
602
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -628,7 +628,7 @@ class OrdersApi:
|
|
|
628
628
|
|
|
629
629
|
@validate_arguments
|
|
630
630
|
def upsert_orders_with_http_info(self, order_set_request : Annotated[Optional[OrderSetRequest], Field(description="The collection of order requests.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
631
|
-
"""
|
|
631
|
+
"""UpsertOrders: Upsert Order # noqa: E501
|
|
632
632
|
|
|
633
633
|
Upsert; update existing orders with given ids, or create new orders otherwise. # noqa: E501
|
|
634
634
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -4100,7 +4100,7 @@ class PortfolioGroupsApi:
|
|
|
4100
4100
|
|
|
4101
4101
|
@validate_arguments
|
|
4102
4102
|
def list_portfolio_groups(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to list the portfolio groups in.")], 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 portfolio groups. 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 portfolio groups. Defaults to return the latest version of each portfolio group 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 portfolio groups from a previous call to list portfolio groups. 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 no limit if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" 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 to sort by, each suffixed by \" ASC\" or \" DESC\"")] = 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 portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPortfolioGroup, Awaitable[PagedResourceListOfPortfolioGroup]]: # noqa: E501
|
|
4103
|
-
"""
|
|
4103
|
+
"""ListPortfolioGroups: List portfolio groups # noqa: E501
|
|
4104
4104
|
|
|
4105
4105
|
List all the portfolio groups in a single scope. # noqa: E501
|
|
4106
4106
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -4148,7 +4148,7 @@ class PortfolioGroupsApi:
|
|
|
4148
4148
|
|
|
4149
4149
|
@validate_arguments
|
|
4150
4150
|
def list_portfolio_groups_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope to list the portfolio groups in.")], 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 portfolio groups. 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 portfolio groups. Defaults to return the latest version of each portfolio group 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 portfolio groups from a previous call to list portfolio groups. 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 no limit if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" 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 to sort by, each suffixed by \" ASC\" or \" DESC\"")] = 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 portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
4151
|
-
"""
|
|
4151
|
+
"""ListPortfolioGroups: List portfolio groups # noqa: E501
|
|
4152
4152
|
|
|
4153
4153
|
List all the portfolio groups in a single scope. # noqa: E501
|
|
4154
4154
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -4870,7 +4870,7 @@ class PortfolioGroupsApi:
|
|
|
4870
4870
|
|
|
4871
4871
|
@validate_arguments
|
|
4872
4872
|
def upsert_portfolio_group_access_metadata(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio Group")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The Portfolio Group code")], metadata_key : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="Key of the access metadata entry to upsert")], upsert_portfolio_group_access_metadata_request : Annotated[UpsertPortfolioGroupAccessMetadataRequest, Field(..., description="The Portfolio Group Access Metadata rule to upsert")], effective_at : Annotated[Optional[StrictStr], Field(description="The date this rule will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAccessMetadataValueOf, Awaitable[ResourceListOfAccessMetadataValueOf]]: # noqa: E501
|
|
4873
|
-
"""
|
|
4873
|
+
"""UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
|
4874
4874
|
|
|
4875
4875
|
Update or insert one Portfolio Group Access Metadata Entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Portfolio Group Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
|
4876
4876
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -4912,7 +4912,7 @@ class PortfolioGroupsApi:
|
|
|
4912
4912
|
|
|
4913
4913
|
@validate_arguments
|
|
4914
4914
|
def upsert_portfolio_group_access_metadata_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio Group")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The Portfolio Group code")], metadata_key : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="Key of the access metadata entry to upsert")], upsert_portfolio_group_access_metadata_request : Annotated[UpsertPortfolioGroupAccessMetadataRequest, Field(..., description="The Portfolio Group Access Metadata rule to upsert")], effective_at : Annotated[Optional[StrictStr], Field(description="The date this rule will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
4915
|
-
"""
|
|
4915
|
+
"""UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
|
|
4916
4916
|
|
|
4917
4917
|
Update or insert one Portfolio Group Access Metadata Entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Portfolio Group Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
|
|
4918
4918
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/portfolios_api.py
CHANGED
|
@@ -262,7 +262,7 @@ class PortfoliosApi:
|
|
|
262
262
|
|
|
263
263
|
@validate_arguments
|
|
264
264
|
def delete_key_from_portfolio_access_metadata(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Quote Access Metadata Rule to retrieve.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Portfolio code")], metadata_key : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The metadataKey identifying the access metadata entry to delete")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective date to delete at, if this is not supplied, it will delete all data found")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
|
265
|
-
"""
|
|
265
|
+
"""DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule # noqa: E501
|
|
266
266
|
|
|
267
267
|
Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts # noqa: E501
|
|
268
268
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -302,7 +302,7 @@ class PortfoliosApi:
|
|
|
302
302
|
|
|
303
303
|
@validate_arguments
|
|
304
304
|
def delete_key_from_portfolio_access_metadata_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Quote Access Metadata Rule to retrieve.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Portfolio code")], metadata_key : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The metadataKey identifying the access metadata entry to delete")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective date to delete at, if this is not supplied, it will delete all data found")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
305
|
-
"""
|
|
305
|
+
"""DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule # noqa: E501
|
|
306
306
|
|
|
307
307
|
Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts # noqa: E501
|
|
308
308
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2009,7 +2009,7 @@ class PortfoliosApi:
|
|
|
2009
2009
|
|
|
2010
2010
|
@validate_arguments
|
|
2011
2011
|
def get_portfolio_aggregated_returns(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Portfolio.")], aggregated_returns_request : Annotated[AggregatedReturnsRequest, Field(..., description="The request used in the AggregatedReturns.")], from_effective_at : Annotated[Optional[StrictStr], Field(description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field(description="The end date for which to calculate the Returns.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AggregatedReturnsResponse, Awaitable[AggregatedReturnsResponse]]: # noqa: E501
|
|
2012
|
-
"""
|
|
2012
|
+
"""GetPortfolioAggregatedReturns: Aggregated Returns # noqa: E501
|
|
2013
2013
|
|
|
2014
2014
|
Aggregate Returns which are on the specified portfolio. # noqa: E501
|
|
2015
2015
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2051,7 +2051,7 @@ class PortfoliosApi:
|
|
|
2051
2051
|
|
|
2052
2052
|
@validate_arguments
|
|
2053
2053
|
def get_portfolio_aggregated_returns_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Portfolio.")], aggregated_returns_request : Annotated[AggregatedReturnsRequest, Field(..., description="The request used in the AggregatedReturns.")], from_effective_at : Annotated[Optional[StrictStr], Field(description="The start date from which to calculate the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field(description="The end date for which to calculate the Returns.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
2054
|
-
"""
|
|
2054
|
+
"""GetPortfolioAggregatedReturns: Aggregated Returns # noqa: E501
|
|
2055
2055
|
|
|
2056
2056
|
Aggregate Returns which are on the specified portfolio. # noqa: E501
|
|
2057
2057
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2415,7 +2415,7 @@ class PortfoliosApi:
|
|
|
2415
2415
|
|
|
2416
2416
|
@validate_arguments
|
|
2417
2417
|
def get_portfolio_metadata(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio Access Metadata Rule to retrieve.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Portfolio code")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which to retrieve the access metadata rule.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio access metadata.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[AccessMetadataValue]], Awaitable[Dict[str, List[AccessMetadataValue]]]]: # noqa: E501
|
|
2418
|
-
"""
|
|
2418
|
+
"""GetPortfolioMetadata: Get access metadata rules for a portfolio # noqa: E501
|
|
2419
2419
|
|
|
2420
2420
|
Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio # noqa: E501
|
|
2421
2421
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2453,7 +2453,7 @@ class PortfoliosApi:
|
|
|
2453
2453
|
|
|
2454
2454
|
@validate_arguments
|
|
2455
2455
|
def get_portfolio_metadata_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio Access Metadata Rule to retrieve.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Portfolio code")], effective_at : Annotated[Optional[StrictStr], Field(description="The effectiveAt datetime at which to retrieve the access metadata rule.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the portfolio access metadata.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
2456
|
-
"""
|
|
2456
|
+
"""GetPortfolioMetadata: Get access metadata rules for a portfolio # noqa: E501
|
|
2457
2457
|
|
|
2458
2458
|
Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio # noqa: E501
|
|
2459
2459
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2771,7 +2771,7 @@ class PortfoliosApi:
|
|
|
2771
2771
|
|
|
2772
2772
|
@validate_arguments
|
|
2773
2773
|
def get_portfolio_property_time_series(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to returning 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 results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, 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 results to this number.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
|
|
2774
|
-
"""
|
|
2774
|
+
"""GetPortfolioPropertyTimeSeries: Get portfolio property time series # noqa: E501
|
|
2775
2775
|
|
|
2776
2776
|
Show the complete time series (history) for a particular portfolio property. # noqa: E501
|
|
2777
2777
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -2817,7 +2817,7 @@ class PortfoliosApi:
|
|
|
2817
2817
|
|
|
2818
2818
|
@validate_arguments
|
|
2819
2819
|
def get_portfolio_property_time_series_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")], portfolio_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to show the history. Defaults to returning 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 results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, 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 results to this number.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
2820
|
-
"""
|
|
2820
|
+
"""GetPortfolioPropertyTimeSeries: Get portfolio property time series # noqa: E501
|
|
2821
2821
|
|
|
2822
2822
|
Show the complete time series (history) for a particular portfolio property. # noqa: E501
|
|
2823
2823
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -3176,7 +3176,7 @@ class PortfoliosApi:
|
|
|
3176
3176
|
|
|
3177
3177
|
@validate_arguments
|
|
3178
3178
|
def get_portfolio_relationships(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], 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 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 returning 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 relationships. Provide a 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
|
|
3179
|
-
"""
|
|
3179
|
+
"""GetPortfolioRelationships: Get portfolio relationships # noqa: E501
|
|
3180
3180
|
|
|
3181
3181
|
Get relationships for a particular portfolio. # noqa: E501
|
|
3182
3182
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -3218,7 +3218,7 @@ class PortfoliosApi:
|
|
|
3218
3218
|
|
|
3219
3219
|
@validate_arguments
|
|
3220
3220
|
def get_portfolio_relationships_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], 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 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 returning 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 relationships. Provide a 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
|
|
3221
|
-
"""
|
|
3221
|
+
"""GetPortfolioRelationships: Get portfolio relationships # noqa: E501
|
|
3222
3222
|
|
|
3223
3223
|
Get relationships for a particular portfolio. # noqa: E501
|
|
3224
3224
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -3371,7 +3371,7 @@ class PortfoliosApi:
|
|
|
3371
3371
|
|
|
3372
3372
|
@validate_arguments
|
|
3373
3373
|
def get_portfolio_returns(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Portfolio.")], return_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Returns.")], return_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Returns.")], from_effective_at : Annotated[Optional[StrictStr], Field(description="The start date from which to get the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field(description="The end date from which to get the Returns.")] = None, period : Annotated[Optional[StrictStr], Field(description="Show the Returns on a Daily or Monthly period. Defaults to Daily.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPerformanceReturn, Awaitable[ResourceListOfPerformanceReturn]]: # noqa: E501
|
|
3374
|
-
"""
|
|
3374
|
+
"""GetPortfolioReturns: Get Returns # noqa: E501
|
|
3375
3375
|
|
|
3376
3376
|
Get Returns which are on the specified portfolio. # noqa: E501
|
|
3377
3377
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -3417,7 +3417,7 @@ class PortfoliosApi:
|
|
|
3417
3417
|
|
|
3418
3418
|
@validate_arguments
|
|
3419
3419
|
def get_portfolio_returns_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Portfolio.")], return_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Returns.")], return_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Returns.")], from_effective_at : Annotated[Optional[StrictStr], Field(description="The start date from which to get the Returns.")] = None, to_effective_at : Annotated[Optional[StrictStr], Field(description="The end date from which to get the Returns.")] = None, period : Annotated[Optional[StrictStr], Field(description="Show the Returns on a Daily or Monthly period. Defaults to Daily.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Returns. Defaults to the latest.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
3420
|
-
"""
|
|
3420
|
+
"""GetPortfolioReturns: Get Returns # noqa: E501
|
|
3421
3421
|
|
|
3422
3422
|
Get Returns which are on the specified portfolio. # noqa: E501
|
|
3423
3423
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -4614,7 +4614,7 @@ class PortfoliosApi:
|
|
|
4614
4614
|
|
|
4615
4615
|
@validate_arguments
|
|
4616
4616
|
def patch_portfolio(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.")], async_req: Optional[bool]=None, **kwargs) -> Union[Portfolio, Awaitable[Portfolio]]: # noqa: E501
|
|
4617
|
-
"""
|
|
4617
|
+
"""PatchPortfolio: Patch portfolio. # noqa: E501
|
|
4618
4618
|
|
|
4619
4619
|
Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: CreationDate, InstrumentScopes. # noqa: E501
|
|
4620
4620
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -4650,7 +4650,7 @@ class PortfoliosApi:
|
|
|
4650
4650
|
|
|
4651
4651
|
@validate_arguments
|
|
4652
4652
|
def patch_portfolio_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the portfolio. Together with the scope this uniquely identifies the portfolio.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.")], **kwargs) -> ApiResponse: # noqa: E501
|
|
4653
|
-
"""
|
|
4653
|
+
"""PatchPortfolio: Patch portfolio. # noqa: E501
|
|
4654
4654
|
|
|
4655
4655
|
Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: CreationDate, InstrumentScopes. # noqa: E501
|
|
4656
4656
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -5728,7 +5728,7 @@ class PortfoliosApi:
|
|
|
5728
5728
|
|
|
5729
5729
|
@validate_arguments
|
|
5730
5730
|
def upsert_portfolio_returns(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Portfolio.")], return_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Returns.")], return_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Returns.")], performance_return : Annotated[conlist(PerformanceReturn), Field(..., description="This contains the Returns which need to be upsert.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertReturnsResponse, Awaitable[UpsertReturnsResponse]]: # noqa: E501
|
|
5731
|
-
"""
|
|
5731
|
+
"""UpsertPortfolioReturns: Upsert Returns # noqa: E501
|
|
5732
5732
|
|
|
5733
5733
|
Update or insert returns into the specified portfolio. # noqa: E501
|
|
5734
5734
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -5768,7 +5768,7 @@ class PortfoliosApi:
|
|
|
5768
5768
|
|
|
5769
5769
|
@validate_arguments
|
|
5770
5770
|
def upsert_portfolio_returns_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Portfolio.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Portfolio.")], return_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Returns.")], return_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Returns.")], performance_return : Annotated[conlist(PerformanceReturn), Field(..., description="This contains the Returns which need to be upsert.")], **kwargs) -> ApiResponse: # noqa: E501
|
|
5771
|
-
"""
|
|
5771
|
+
"""UpsertPortfolioReturns: Upsert Returns # noqa: E501
|
|
5772
5772
|
|
|
5773
5773
|
Update or insert returns into the specified portfolio. # noqa: E501
|
|
5774
5774
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1884,7 +1884,7 @@ class PropertyDefinitionsApi:
|
|
|
1884
1884
|
|
|
1885
1885
|
@validate_arguments
|
|
1886
1886
|
def upsert_property_definition_properties(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified property.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'PropertyDefinition/Manager/Id'.")], success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpsertPropertyDefinitionPropertiesResponse, Awaitable[BatchUpsertPropertyDefinitionPropertiesResponse]]: # noqa: E501
|
|
1887
|
-
"""
|
|
1887
|
+
"""UpsertPropertyDefinitionProperties: Upsert properties to a property definition # noqa: E501
|
|
1888
1888
|
|
|
1889
1889
|
Create or update properties for a particular property definition # noqa: E501
|
|
1890
1890
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -1924,7 +1924,7 @@ class PropertyDefinitionsApi:
|
|
|
1924
1924
|
|
|
1925
1925
|
@validate_arguments
|
|
1926
1926
|
def upsert_property_definition_properties_with_http_info(self, domain : Annotated[StrictStr, Field(..., description="The domain of the specified property.")], scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified property.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified property. Together with the domain and scope this uniquely")], request_body : Annotated[Dict[str, ModelProperty], Field(..., description="The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'PropertyDefinition/Manager/Id'.")], success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1927
|
-
"""
|
|
1927
|
+
"""UpsertPropertyDefinitionProperties: Upsert properties to a property definition # noqa: E501
|
|
1928
1928
|
|
|
1929
1929
|
Create or update properties for a particular property definition # noqa: E501
|
|
1930
1930
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/quotes_api.py
CHANGED
|
@@ -440,7 +440,7 @@ class QuotesApi:
|
|
|
440
440
|
|
|
441
441
|
@validate_arguments
|
|
442
442
|
def get_quotes(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the quotes to retrieve.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the quotes. 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 quotes. Defaults to return the latest version of each quote if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field(description="The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime or cut label to generate a effective datetime window inside which a quote must exist to be retrieved.")] = None, request_body : Annotated[Optional[Dict[str, QuoteSeriesId]], Field(description="The time invariant quote series ids of the quotes to retrieve. These need to be keyed by a unique correlation id allowing the retrieved quote to be identified in the response.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetQuotesResponse, Awaitable[GetQuotesResponse]]: # noqa: E501
|
|
443
|
-
"""
|
|
443
|
+
"""GetQuotes: Get quotes # noqa: E501
|
|
444
444
|
|
|
445
445
|
Get one or more quotes from a single scope. Each quote can be identified by its time invariant quote series id. For each quote series id LUSID will return the most recent quote with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for a quote from the specified effective datetime. LUSID will return the most recent quote within this window. In the request each quote series id 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 quote in the response. The response will return three collections. One, the successfully retrieved quotes. Two, those that had a valid quote series id but could not be found. Three, those that failed because LUSID could not construct a valid quote series id from the request. For the quotes that failed or could not be found a reason will be provided explaining why the quote could not be retrieved. It is important to always check the failed and not found sets for any unsuccessful results. The maximum number of quotes that this method can get per request is 2,000. # noqa: E501
|
|
446
446
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -480,7 +480,7 @@ class QuotesApi:
|
|
|
480
480
|
|
|
481
481
|
@validate_arguments
|
|
482
482
|
def get_quotes_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the quotes to retrieve.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the quotes. 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 quotes. Defaults to return the latest version of each quote if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field(description="The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime or cut label to generate a effective datetime window inside which a quote must exist to be retrieved.")] = None, request_body : Annotated[Optional[Dict[str, QuoteSeriesId]], Field(description="The time invariant quote series ids of the quotes to retrieve. These need to be keyed by a unique correlation id allowing the retrieved quote to be identified in the response.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
483
|
-
"""
|
|
483
|
+
"""GetQuotes: Get quotes # noqa: E501
|
|
484
484
|
|
|
485
485
|
Get one or more quotes from a single scope. Each quote can be identified by its time invariant quote series id. For each quote series id LUSID will return the most recent quote with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for a quote from the specified effective datetime. LUSID will return the most recent quote within this window. In the request each quote series id 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 quote in the response. The response will return three collections. One, the successfully retrieved quotes. Two, those that had a valid quote series id but could not be found. Three, those that failed because LUSID could not construct a valid quote series id from the request. For the quotes that failed or could not be found a reason will be provided explaining why the quote could not be retrieved. It is important to always check the failed and not found sets for any unsuccessful results. The maximum number of quotes that this method can get per request is 2,000. # noqa: E501
|
|
486
486
|
This method makes a synchronous HTTP request by default. To make an
|
lusid/api/relationships_api.py
CHANGED
|
@@ -57,7 +57,7 @@ class RelationshipsApi:
|
|
|
57
57
|
|
|
58
58
|
@validate_arguments
|
|
59
59
|
def create_relationship(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the relationship")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the relationship")], create_relationship_request : Annotated[CreateRelationshipRequest, Field(..., description="The details of the relationship to create.")], async_req: Optional[bool]=None, **kwargs) -> Union[CompleteRelationship, Awaitable[CompleteRelationship]]: # noqa: E501
|
|
60
|
-
"""
|
|
60
|
+
"""CreateRelationship: Create Relationship # noqa: E501
|
|
61
61
|
|
|
62
62
|
Create a relationship between two entity objects by their identifiers # noqa: E501
|
|
63
63
|
This method makes a synchronous HTTP request by default. To make an
|
|
@@ -93,7 +93,7 @@ class RelationshipsApi:
|
|
|
93
93
|
|
|
94
94
|
@validate_arguments
|
|
95
95
|
def create_relationship_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the relationship")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the relationship")], create_relationship_request : Annotated[CreateRelationshipRequest, Field(..., description="The details of the relationship to create.")], **kwargs) -> ApiResponse: # noqa: E501
|
|
96
|
-
"""
|
|
96
|
+
"""CreateRelationship: Create Relationship # noqa: E501
|
|
97
97
|
|
|
98
98
|
Create a relationship between two entity objects by their identifiers # noqa: E501
|
|
99
99
|
This method makes a synchronous HTTP request by default. To make an
|