sdk.lusid.api.legal_entities_api.LegalEntitiesApi
- class LegalEntitiesApi(api_client=None)[source]
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Methods
DeleteLegalEntity: Delete Legal Entity # noqa: E501
DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry # noqa: E501
DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry # noqa: E501
[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers # noqa: E501
[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers # noqa: E501
[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties # noqa: E501
[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties # noqa: E501
DeleteLegalEntity: Delete Legal Entity # noqa: E501
GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity # noqa: E501
GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity # noqa: E501
GetLegalEntity: Get Legal Entity # noqa: E501
[EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity # noqa: E501
[EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity # noqa: E501
GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series # noqa: E501
GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series # noqa: E501
GetLegalEntityRelations: Get Relations for Legal Entity # noqa: E501
GetLegalEntityRelations: Get Relations for Legal Entity # noqa: E501
GetLegalEntityRelationships: Get Relationships for Legal Entity # noqa: E501
GetLegalEntityRelationships: Get Relationships for Legal Entity # noqa: E501
GetLegalEntity: Get Legal Entity # noqa: E501
ListAllLegalEntities: List Legal Entities # noqa: E501
ListAllLegalEntities: List Legal Entities # noqa: E501
ListLegalEntities: List Legal Entities # noqa: E501
ListLegalEntities: List Legal Entities # noqa: E501
[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity.
[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity.
[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers # noqa: E501
[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers # noqa: E501
SetLegalEntityProperties: Set Legal Entity Properties # noqa: E501
SetLegalEntityProperties: Set Legal Entity Properties # noqa: E501
[EARLY ACCESS] UpsertLegalEntities: Batch upsert Legal Entities # noqa: E501
[EARLY ACCESS] UpsertLegalEntities: Batch upsert Legal Entities # noqa: E501
UpsertLegalEntity: Upsert Legal Entity # noqa: E501
UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey.
UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey.
UpsertLegalEntity: Upsert Legal Entity # noqa: E501
- delete_legal_entity(id_type_scope, id_type_code, code, async_req=None, **kwargs)[source]
DeleteLegalEntity: Delete Legal Entity # noqa: E501
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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_legal_entity(id_type_scope, id_type_code, code, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – The scope of the legal entity identifier type. (required)
id_type_code (str) – The code of the legal entity identifier type. (required)
code (str) – 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. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_legal_entity_access_metadata(id_type_scope, id_type_code, code, metadata_key, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]
DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry # noqa: E501
Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_legal_entity_access_metadata(id_type_scope, id_type_code, code, metadata_key, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found
effective_until (datetime) – 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
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_legal_entity_access_metadata_with_http_info(id_type_scope, id_type_code, code, metadata_key, effective_at=None, effective_until=None, **kwargs)[source]
DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry # noqa: E501
Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_legal_entity_access_metadata_with_http_info(id_type_scope, id_type_code, code, metadata_key, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found
effective_until (datetime) – 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
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- delete_legal_entity_identifiers(id_type_scope, id_type_code, code, property_keys, effective_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers # noqa: E501
Delete identifiers that belong to the given property keys of the legal entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_legal_entity_identifiers(id_type_scope, id_type_code, code, property_keys, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
property_keys (List[str]) – The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. “LegalEntity/CreditAgency/Identifier”. Each property must be from the “LegalEntity” domain. Identifiers or identifiers not specified in request will not be changed. (required)
effective_at (str) – The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_legal_entity_identifiers_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at=None, **kwargs)[source]
[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers # noqa: E501
Delete identifiers that belong to the given property keys of the legal entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_legal_entity_identifiers_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
property_keys (List[str]) – The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. “LegalEntity/CreditAgency/Identifier”. Each property must be from the “LegalEntity” domain. Identifiers or identifiers not specified in request will not be changed. (required)
effective_at (str) – The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- delete_legal_entity_properties(id_type_scope, id_type_code, code, property_keys, effective_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties # noqa: E501
Delete all properties that belong to the given property keys of the legal entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_legal_entity_properties(id_type_scope, id_type_code, code, property_keys, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
property_keys (List[str]) – The property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. “LegalEntity/CompanyDetails/Role”. Each property must be from the “LegalEntity” domain. Properties or identifiers not specified in request will not be changed. (required)
effective_at (str) – The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified ‘effectiveAt’ datetime. If the ‘effectiveAt’ is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_legal_entity_properties_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at=None, **kwargs)[source]
[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties # noqa: E501
Delete all properties that belong to the given property keys of the legal entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_legal_entity_properties_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
property_keys (List[str]) – The property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. “LegalEntity/CompanyDetails/Role”. Each property must be from the “LegalEntity” domain. Properties or identifiers not specified in request will not be changed. (required)
effective_at (str) – The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified ‘effectiveAt’ datetime. If the ‘effectiveAt’ is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- delete_legal_entity_with_http_info(id_type_scope, id_type_code, code, **kwargs)[source]
DeleteLegalEntity: Delete Legal Entity # noqa: E501
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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_legal_entity_with_http_info(id_type_scope, id_type_code, code, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – The scope of the legal entity identifier type. (required)
id_type_code (str) – The code of the legal entity identifier type. (required)
code (str) – 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. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- get_all_legal_entity_access_metadata(id_type_scope, id_type_code, code, effective_at=None, as_at=None, async_req=None, **kwargs)[source]
GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity # noqa: E501
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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_legal_entity_access_metadata(id_type_scope, id_type_code, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata
as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
Dict[str, List[AccessMetadataValue]]
- get_all_legal_entity_access_metadata_with_http_info(id_type_scope, id_type_code, code, effective_at=None, as_at=None, **kwargs)[source]
GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity # noqa: E501
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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_legal_entity_access_metadata_with_http_info(id_type_scope, id_type_code, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata
as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))
- get_legal_entity(id_type_scope, id_type_code, code, property_keys=None, effective_at=None, as_at=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]
GetLegalEntity: Get Legal Entity # noqa: E501
Retrieve the definition of a legal entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity(id_type_scope, id_type_code, code, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
property_keys (List[str]) – 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”.
effective_at (str) – The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified.
relationship_definition_ids (List[str]) – 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}.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_legal_entity_access_metadata_by_key(id_type_scope, id_type_code, code, metadata_key, effective_at=None, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity # noqa: E501
Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_access_metadata_by_key(id_type_scope, id_type_code, code, metadata_key, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata
as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
List[AccessMetadataValue]
- get_legal_entity_access_metadata_by_key_with_http_info(id_type_scope, id_type_code, code, metadata_key, effective_at=None, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity # noqa: E501
Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_access_metadata_by_key_with_http_info(id_type_scope, id_type_code, code, metadata_key, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata
as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(List[AccessMetadataValue], status_code(int), headers(HTTPHeaderDict))
- get_legal_entity_property_time_series(id_type_scope, id_type_code, code, property_key, as_at=None, filter=None, page=None, limit=None, async_req=None, **kwargs)[source]
GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series # noqa: E501
List the complete time series of a legal entity property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_property_time_series(id_type_scope, id_type_code, code, property_key, as_at, filter, page, limit, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
property_key (str) – 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. (required)
as_at (datetime) – The asAt datetime at which to list the person’s property history. Defaults to return the current datetime if not supplied.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
page (str) – 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.
limit (int) – When paginating, limit the number of returned results to this many.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_legal_entity_property_time_series_with_http_info(id_type_scope, id_type_code, code, property_key, as_at=None, filter=None, page=None, limit=None, **kwargs)[source]
GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series # noqa: E501
List the complete time series of a legal entity property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_property_time_series_with_http_info(id_type_scope, id_type_code, code, property_key, as_at, filter, page, limit, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
property_key (str) – 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. (required)
as_at (datetime) – The asAt datetime at which to list the person’s property history. Defaults to return the current datetime if not supplied.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
page (str) – 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.
limit (int) – When paginating, limit the number of returned results to this many.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfPropertyInterval, status_code(int), headers(HTTPHeaderDict))
- get_legal_entity_relations(id_type_scope, id_type_code, code, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)[source]
GetLegalEntityRelations: Get Relations for Legal Entity # noqa: E501
Get relations for the specified Legal Entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_relations(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
effective_at (str) – The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the legal entity’s relations. Defaults to return the latest LUSID AsAt time if not specified.
filter (str) – Expression to filter the relations. Users should provide null or empty string for this field until further notice.
identifier_types (List[str]) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_legal_entity_relations_with_http_info(id_type_scope, id_type_code, code, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)[source]
GetLegalEntityRelations: Get Relations for Legal Entity # noqa: E501
Get relations for the specified Legal Entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_relations_with_http_info(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
effective_at (str) – The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the legal entity’s relations. Defaults to return the latest LUSID AsAt time if not specified.
filter (str) – Expression to filter the relations. Users should provide null or empty string for this field until further notice.
identifier_types (List[str]) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfRelation, status_code(int), headers(HTTPHeaderDict))
- get_legal_entity_relationships(id_type_scope, id_type_code, code, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)[source]
GetLegalEntityRelationships: Get Relationships for Legal Entity # noqa: E501
Get Relationships for the specified Legal Entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_relationships(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity’s identifier type. (required)
id_type_code (str) – Code of the legal entity’s identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
effective_at (str) – The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.
filter (str) – Expression to filter relationships. Users should provide null or empty string for this field until further notice.
identifier_types (List[str]) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_legal_entity_relationships_with_http_info(id_type_scope, id_type_code, code, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)[source]
GetLegalEntityRelationships: Get Relationships for Legal Entity # noqa: E501
Get Relationships for the specified Legal Entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_relationships_with_http_info(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity’s identifier type. (required)
id_type_code (str) – Code of the legal entity’s identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
effective_at (str) – The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.
filter (str) – Expression to filter relationships. Users should provide null or empty string for this field until further notice.
identifier_types (List[str]) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfRelationship, status_code(int), headers(HTTPHeaderDict))
- get_legal_entity_with_http_info(id_type_scope, id_type_code, code, property_keys=None, effective_at=None, as_at=None, relationship_definition_ids=None, **kwargs)[source]
GetLegalEntity: Get Legal Entity # noqa: E501
Retrieve the definition of a legal entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_legal_entity_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
property_keys (List[str]) – 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”.
effective_at (str) – The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified.
relationship_definition_ids (List[str]) – 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}.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(LegalEntity, status_code(int), headers(HTTPHeaderDict))
- list_all_legal_entities(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]
ListAllLegalEntities: List Legal Entities # noqa: E501
List all legal entities which the user is entitled to see. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_all_legal_entities(effective_at, as_at, page, limit, filter, sort_by, property_keys, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified.
page (str) – 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.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
property_keys (List[str]) – 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”.
relationship_definition_ids (List[str]) – 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}.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_all_legal_entities_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, relationship_definition_ids=None, **kwargs)[source]
ListAllLegalEntities: List Legal Entities # noqa: E501
List all legal entities which the user is entitled to see. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_all_legal_entities_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified.
page (str) – 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.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
property_keys (List[str]) – 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”.
relationship_definition_ids (List[str]) – 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}.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfLegalEntity, status_code(int), headers(HTTPHeaderDict))
- list_legal_entities(id_type_scope, id_type_code, effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]
ListLegalEntities: List Legal Entities # noqa: E501
List legal entities which has identifier of specific identifier type’s scope and code, and satisfies filter criteria. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_legal_entities(id_type_scope, id_type_code, effective_at, as_at, page, limit, filter, sort_by, property_keys, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
effective_at (str) – The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
page (str) – 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.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
property_keys (List[str]) – 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”.
relationship_definition_ids (List[str]) – 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}.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_legal_entities_with_http_info(id_type_scope, id_type_code, effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, relationship_definition_ids=None, **kwargs)[source]
ListLegalEntities: List Legal Entities # noqa: E501
List legal entities which has identifier of specific identifier type’s scope and code, and satisfies filter criteria. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_legal_entities_with_http_info(id_type_scope, id_type_code, effective_at, as_at, page, limit, filter, sort_by, property_keys, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
effective_at (str) – The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
page (str) – 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.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
property_keys (List[str]) – 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”.
relationship_definition_ids (List[str]) – 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}.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(PagedResourceListOfLegalEntity, status_code(int), headers(HTTPHeaderDict))
- patch_legal_entity_access_metadata(id_type_scope, id_type_code, code, access_metadata_operation, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. # noqa: E501
Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only ‘add’ is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Legal Entity Access Metadata rules or a 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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.patch_legal_entity_access_metadata(id_type_scope, id_type_code, code, access_metadata_operation, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
access_metadata_operation (List[AccessMetadataOperation]) – The Json Patch document (required)
effective_at (str) – The effectiveAt datetime at which to upsert the Access Metadata
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
Dict[str, List[AccessMetadataValue]]
- patch_legal_entity_access_metadata_with_http_info(id_type_scope, id_type_code, code, access_metadata_operation, effective_at=None, effective_until=None, **kwargs)[source]
[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. # noqa: E501
Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only ‘add’ is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Legal Entity Access Metadata rules or a 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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.patch_legal_entity_access_metadata_with_http_info(id_type_scope, id_type_code, code, access_metadata_operation, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
access_metadata_operation (List[AccessMetadataOperation]) – The Json Patch document (required)
effective_at (str) – The effectiveAt datetime at which to upsert the Access Metadata
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))
- set_legal_entity_identifiers(id_type_scope, id_type_code, code, set_legal_entity_identifiers_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers # noqa: E501
Set identifiers of the Legal Entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_legal_entity_identifiers(id_type_scope, id_type_code, code, set_legal_entity_identifiers_request, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
set_legal_entity_identifiers_request (SetLegalEntityIdentifiersRequest) – Request containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- set_legal_entity_identifiers_with_http_info(id_type_scope, id_type_code, code, set_legal_entity_identifiers_request, **kwargs)[source]
[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers # noqa: E501
Set identifiers of the Legal Entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_legal_entity_identifiers_with_http_info(id_type_scope, id_type_code, code, set_legal_entity_identifiers_request, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
set_legal_entity_identifiers_request (SetLegalEntityIdentifiersRequest) – Request containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(LegalEntity, status_code(int), headers(HTTPHeaderDict))
- set_legal_entity_properties(id_type_scope, id_type_code, code, set_legal_entity_properties_request, async_req=None, **kwargs)[source]
SetLegalEntityProperties: Set Legal Entity Properties # noqa: E501
Set properties of the legal entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_legal_entity_properties(id_type_scope, id_type_code, code, set_legal_entity_properties_request, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
set_legal_entity_properties_request (SetLegalEntityPropertiesRequest) – Request containing properties to set for the legal entity. Properties not specified in request will not be changed. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- set_legal_entity_properties_with_http_info(id_type_scope, id_type_code, code, set_legal_entity_properties_request, **kwargs)[source]
SetLegalEntityProperties: Set Legal Entity Properties # noqa: E501
Set properties of the legal entity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_legal_entity_properties_with_http_info(id_type_scope, id_type_code, code, set_legal_entity_properties_request, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the legal entity identifier type. (required)
id_type_code (str) – Code of the legal entity identifier type. (required)
code (str) – Code of the legal entity under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the legal entity. (required)
set_legal_entity_properties_request (SetLegalEntityPropertiesRequest) – Request containing properties to set for the legal entity. Properties not specified in request will not be changed. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(LegalEntity, status_code(int), headers(HTTPHeaderDict))
- upsert_legal_entities(success_mode, request_body, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertLegalEntities: Batch upsert Legal Entities # noqa: E501
Creates or updates a collection of Legal Entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_legal_entities(success_mode, request_body, async_req=True) >>> result = thread.get()
- Parameters:
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
request_body (Dict[str, UpsertLegalEntityRequest]) – A collection of requests to create or update Legal Entities. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- upsert_legal_entities_with_http_info(success_mode, request_body, **kwargs)[source]
[EARLY ACCESS] UpsertLegalEntities: Batch upsert Legal Entities # noqa: E501
Creates or updates a collection of Legal Entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_legal_entities_with_http_info(success_mode, request_body, async_req=True) >>> result = thread.get()
- Parameters:
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
request_body (Dict[str, UpsertLegalEntityRequest]) – A collection of requests to create or update Legal Entities. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(UpsertLegalEntitiesResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_legal_entity(upsert_legal_entity_request, async_req=None, **kwargs)[source]
UpsertLegalEntity: Upsert Legal Entity # noqa: E501
Create or update a legal entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_legal_entity(upsert_legal_entity_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_legal_entity_request (UpsertLegalEntityRequest) – Request to create or update a legal entity. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- upsert_legal_entity_access_metadata(id_type_scope, id_type_code, code, metadata_key, upsert_legal_entity_access_metadata_request, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]
UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
Update or insert one Legal Entity 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 Legal Entity 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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_legal_entity_access_metadata(id_type_scope, id_type_code, code, metadata_key, upsert_legal_entity_access_metadata_request, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
upsert_legal_entity_access_metadata_request (UpsertLegalEntityAccessMetadataRequest) – The Legal Entity Access Metadata entry to upsert (required)
effective_at (str) – The effectiveAt datetime at which to upsert the Access Metadata
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- upsert_legal_entity_access_metadata_with_http_info(id_type_scope, id_type_code, code, metadata_key, upsert_legal_entity_access_metadata_request, effective_at=None, effective_until=None, **kwargs)[source]
UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
Update or insert one Legal Entity 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 Legal Entity 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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_legal_entity_access_metadata_with_http_info(id_type_scope, id_type_code, code, metadata_key, upsert_legal_entity_access_metadata_request, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the Legal Entity identifier. (required)
id_type_code (str) – Code of the Legal Entity identifier. (required)
code (str) – Code of the Legal Entity under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
upsert_legal_entity_access_metadata_request (UpsertLegalEntityAccessMetadataRequest) – The Legal Entity Access Metadata entry to upsert (required)
effective_at (str) – The effectiveAt datetime at which to upsert the Access Metadata
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfAccessMetadataValueOf, status_code(int), headers(HTTPHeaderDict))
- upsert_legal_entity_with_http_info(upsert_legal_entity_request, **kwargs)[source]
UpsertLegalEntity: Upsert Legal Entity # noqa: E501
Create or update a legal entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_legal_entity_with_http_info(upsert_legal_entity_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_legal_entity_request (UpsertLegalEntityRequest) – Request to create or update a legal entity. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(LegalEntity, status_code(int), headers(HTTPHeaderDict))