sdk.lusid.api.investor_records_api.InvestorRecordsApi

class InvestorRecordsApi(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

`delete_investor_record`	[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record # noqa: E501
`delete_investor_record_access_metadata`	[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry.
`delete_investor_record_access_metadata_with_http_info`	[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry.
`delete_investor_record_with_http_info`	[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record # noqa: E501
`get_all_investor_record_access_metadata`	[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record.
`get_all_investor_record_access_metadata_with_http_info`	[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record.
`get_investor_record`	[EARLY ACCESS] GetInvestorRecord: Get Investor Record # noqa: E501
`get_investor_record_relationships`	[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships # noqa: E501
`get_investor_record_relationships_with_http_info`	[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships # noqa: E501
`get_investor_record_with_http_info`	[EARLY ACCESS] GetInvestorRecord: Get Investor Record # noqa: E501
`list_all_investor_records`	[EARLY ACCESS] ListAllInvestorRecords: List Investor Records # noqa: E501
`list_all_investor_records_with_http_info`	[EARLY ACCESS] ListAllInvestorRecords: List Investor Records # noqa: E501
`patch_investor_record_access_metadata`	[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record.
`patch_investor_record_access_metadata_with_http_info`	[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record.
`upsert_investor_records`	[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records # noqa: E501
`upsert_investor_records_with_http_info`	[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records # noqa: E501

delete_investor_record(identifier_type, identifier_value, scope, identifier_scope, async_req=None, **kwargs)[source]

[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record # noqa: E501

Delete an investor record. Deletion will be valid from the investor record’s creation datetime. This means that the investor record 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_investor_record(identifier_type, identifier_value, scope, identifier_scope, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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:

DeletedEntityResponse

delete_investor_record_access_metadata(identifier_type, identifier_value, metadata_key, scope, identifier_scope, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. # noqa: E501

Deletes the Investor Record 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_investor_record_access_metadata(identifier_type, identifier_value, metadata_key, scope, identifier_scope, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to delete (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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:

DeletedEntityResponse

delete_investor_record_access_metadata_with_http_info(identifier_type, identifier_value, metadata_key, scope, identifier_scope, effective_at=None, effective_until=None, **kwargs)[source]

[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. # noqa: E501

Deletes the Investor Record 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_investor_record_access_metadata_with_http_info(identifier_type, identifier_value, metadata_key, scope, identifier_scope, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to delete (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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_investor_record_with_http_info(identifier_type, identifier_value, scope, identifier_scope, **kwargs)[source]

[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record # noqa: E501

Delete an investor record. Deletion will be valid from the investor record’s creation datetime. This means that the investor record 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_investor_record_with_http_info(identifier_type, identifier_value, scope, identifier_scope, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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_investor_record_access_metadata(identifier_type, identifier_value, scope, identifier_scope, effective_at=None, as_at=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. # noqa: E501

Pass the Scope and Code of the Investor Record identifier along with the identifier value 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_investor_record_access_metadata(identifier_type, identifier_value, scope, identifier_scope, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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_investor_record_access_metadata_with_http_info(identifier_type, identifier_value, scope, identifier_scope, effective_at=None, as_at=None, **kwargs)[source]

[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. # noqa: E501

Pass the Scope and Code of the Investor Record identifier along with the identifier value 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_investor_record_access_metadata_with_http_info(identifier_type, identifier_value, scope, identifier_scope, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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_investor_record(identifier_type, identifier_value, scope, identifier_scope, property_keys=None, effective_at=None, as_at=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetInvestorRecord: Get Investor Record # noqa: E501

Retrieve the definition of a investor record. # 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_investor_record(identifier_type, identifier_value, scope, identifier_scope, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (required)
property_keys (List[str]) – A list of property keys or identifier types (as property keys) from the “InvestorRecord” domain to include for found investor record, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “InvestorRecord/ContactDetails/Address”.
effective_at (str) – The effective datetime or cut label at which to retrieve the investor record. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the investor record. Defaults to return the latest version of the investor record if not specified.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the investor record 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:

InvestorRecord

get_investor_record_relationships(identifier_type, identifier_value, scope, identifier_scope, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships # noqa: E501

Get relationships for a particular Investor Record. # 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_investor_record_relationships(identifier_type, identifier_value, scope, identifier_scope, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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:

ResourceListOfRelationship

get_investor_record_relationships_with_http_info(identifier_type, identifier_value, scope, identifier_scope, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)[source]

[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships # noqa: E501

Get relationships for a particular Investor Record. # 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_investor_record_relationships_with_http_info(identifier_type, identifier_value, scope, identifier_scope, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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_investor_record_with_http_info(identifier_type, identifier_value, scope, identifier_scope, property_keys=None, effective_at=None, as_at=None, relationship_definition_ids=None, **kwargs)[source]

[EARLY ACCESS] GetInvestorRecord: Get Investor Record # noqa: E501

Retrieve the definition of a investor record. # 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_investor_record_with_http_info(identifier_type, identifier_value, scope, identifier_scope, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (required)
property_keys (List[str]) – A list of property keys or identifier types (as property keys) from the “InvestorRecord” domain to include for found investor record, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “InvestorRecord/ContactDetails/Address”.
effective_at (str) – The effective datetime or cut label at which to retrieve the investor record. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the investor record. Defaults to return the latest version of the investor record if not specified.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the investor record 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(InvestorRecord, status_code(int), headers(HTTPHeaderDict))

list_all_investor_records(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]

[EARLY ACCESS] ListAllInvestorRecords: List Investor Records # noqa: E501

List all investor records 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_investor_records(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 investor records. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the investor records. Defaults to return the latest version of each investor records if not specified.
page (str) – The pagination token to use to continue listing investor records from a previous call to list investor records. 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 “InvestorRecord” domain to include for each investor record, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “InvestorRecord/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:

ResourceListOfInvestorRecord

list_all_investor_records_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]

[EARLY ACCESS] ListAllInvestorRecords: List Investor Records # noqa: E501

List all investor records 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_investor_records_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 investor records. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the investor records. Defaults to return the latest version of each investor records if not specified.
page (str) – The pagination token to use to continue listing investor records from a previous call to list investor records. 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 “InvestorRecord” domain to include for each investor record, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “InvestorRecord/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(ResourceListOfInvestorRecord, status_code(int), headers(HTTPHeaderDict))

patch_investor_record_access_metadata(identifier_type, identifier_value, scope, identifier_scope, access_metadata_operation, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. # noqa: E501

Patch Investor Record 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 Investor Record 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_investor_record_access_metadata(identifier_type, identifier_value, scope, identifier_scope, access_metadata_operation, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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_investor_record_access_metadata_with_http_info(identifier_type, identifier_value, scope, identifier_scope, access_metadata_operation, effective_at=None, effective_until=None, **kwargs)[source]

[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. # noqa: E501

Patch Investor Record 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 Investor Record 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_investor_record_access_metadata_with_http_info(identifier_type, identifier_value, scope, identifier_scope, access_metadata_operation, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

identifier_type (str) – Code of the investor record identifier type. (required)
identifier_value (str) – Code of the investor record under specified identifier type’s scope and code. (required)
scope (str) – The scope of the investor record entity. (required)
identifier_scope (str) – Scope of the investor record identifier type. (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))

upsert_investor_records(success_mode, request_body, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records # noqa: E501

Creates or updates a collection of Investor Records # 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_investor_records(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, UpsertInvestorRecordRequest]) – A collection of requests to create or update Investor Records. (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:

UpsertInvestorRecordsResponse

upsert_investor_records_with_http_info(success_mode, request_body, **kwargs)[source]

[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records # noqa: E501

Creates or updates a collection of Investor Records # 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_investor_records_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, UpsertInvestorRecordRequest]) – A collection of requests to create or update Investor Records. (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(UpsertInvestorRecordsResponse, status_code(int), headers(HTTPHeaderDict))