Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.InvestorRecordsApi:

[legend]

Public Member Functions
	InvestorRecordsApi ()
	Initializes a new instance of the InvestorRecordsApi class. More...

	InvestorRecordsApi (string basePath)
	Initializes a new instance of the InvestorRecordsApi class. More...

	InvestorRecordsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the InvestorRecordsApi class using Configuration object More...

	InvestorRecordsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the InvestorRecordsApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

DeletedEntityResponse	DeleteInvestorRecord (string identifierType, string identifierValue, string scope, string identifierScope, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record 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. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteInvestorRecordWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record 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. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteInvestorRecordAsync (string identifierType, string identifierValue, string scope, string identifierScope, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteInvestorRecordWithHttpInfoAsync (string identifierType, string identifierValue, string scope, string identifierScope, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record 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. More...

DeletedEntityResponse	DeleteInvestorRecordAccessMetadata (string identifierType, string identifierValue, string metadataKey, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. 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). More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteInvestorRecordAccessMetadataWithHttpInfo (string identifierType, string identifierValue, string metadataKey, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. 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). More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteInvestorRecordAccessMetadataAsync (string identifierType, string identifierValue, string metadataKey, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. 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). More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteInvestorRecordAccessMetadataWithHttpInfoAsync (string identifierType, string identifierValue, string metadataKey, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. 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). More...

Dictionary< string, List< AccessMetadataValue > >	GetAllInvestorRecordAccessMetadata (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata. More...

Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > >	GetAllInvestorRecordAccessMetadataWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata. More...

async System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > >	GetAllInvestorRecordAccessMetadataAsync (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > >	GetAllInvestorRecordAccessMetadataWithHttpInfoAsync (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata. More...

InvestorRecord	GetInvestorRecord (string identifierType, string identifierValue, string scope, string identifierScope, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetInvestorRecord: Get Investor Record Retrieve the definition of a investor record. More...

Lusid.Sdk.Client.ApiResponse< InvestorRecord >	GetInvestorRecordWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetInvestorRecord: Get Investor Record Retrieve the definition of a investor record. More...

async System.Threading.Tasks.Task< InvestorRecord >	GetInvestorRecordAsync (string identifierType, string identifierValue, string scope, string identifierScope, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetInvestorRecord: Get Investor Record Retrieve the definition of a investor record. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< InvestorRecord > >	GetInvestorRecordWithHttpInfoAsync (string identifierType, string identifierValue, string scope, string identifierScope, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetInvestorRecord: Get Investor Record Retrieve the definition of a investor record. More...

ResourceListOfRelationship	GetInvestorRecordRelationships (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships Get relationships for a particular Investor Record. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship >	GetInvestorRecordRelationshipsWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships Get relationships for a particular Investor Record. More...

async System.Threading.Tasks.Task< ResourceListOfRelationship >	GetInvestorRecordRelationshipsAsync (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships Get relationships for a particular Investor Record. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > >	GetInvestorRecordRelationshipsWithHttpInfoAsync (string identifierType, string identifierValue, string scope, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships Get relationships for a particular Investor Record. More...

ResourceListOfInvestorRecord	ListAllInvestorRecords (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListAllInvestorRecords: List Investor Records List all investor records which the user is entitled to see. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfInvestorRecord >	ListAllInvestorRecordsWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListAllInvestorRecords: List Investor Records List all investor records which the user is entitled to see. More...

async System.Threading.Tasks.Task< ResourceListOfInvestorRecord >	ListAllInvestorRecordsAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListAllInvestorRecords: List Investor Records List all investor records which the user is entitled to see. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfInvestorRecord > >	ListAllInvestorRecordsWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListAllInvestorRecords: List Investor Records List all investor records which the user is entitled to see. More...

Dictionary< string, List< AccessMetadataValue > >	PatchInvestorRecordAccessMetadata (string identifierType, string identifierValue, string scope, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. 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. More...

Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > >	PatchInvestorRecordAccessMetadataWithHttpInfo (string identifierType, string identifierValue, string scope, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. 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. More...

async System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > >	PatchInvestorRecordAccessMetadataAsync (string identifierType, string identifierValue, string scope, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > >	PatchInvestorRecordAccessMetadataWithHttpInfoAsync (string identifierType, string identifierValue, string scope, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. 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. More...

UpsertInvestorRecordsResponse	UpsertInvestorRecords (string successMode, Dictionary< string, UpsertInvestorRecordRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records Creates or updates a collection of Investor Records More...

Lusid.Sdk.Client.ApiResponse< UpsertInvestorRecordsResponse >	UpsertInvestorRecordsWithHttpInfo (string successMode, Dictionary< string, UpsertInvestorRecordRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records Creates or updates a collection of Investor Records More...

async System.Threading.Tasks.Task< UpsertInvestorRecordsResponse >	UpsertInvestorRecordsAsync (string successMode, Dictionary< string, UpsertInvestorRecordRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records Creates or updates a collection of Investor Records More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertInvestorRecordsResponse > >	UpsertInvestorRecordsWithHttpInfoAsync (string successMode, Dictionary< string, UpsertInvestorRecordRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records Creates or updates a collection of Investor Records More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ InvestorRecordsApi() [1/4]

Lusid.Sdk.Api.InvestorRecordsApi.InvestorRecordsApi ( )

inline

Initializes a new instance of the InvestorRecordsApi class.

Returns

◆ InvestorRecordsApi() [2/4]

Lusid.Sdk.Api.InvestorRecordsApi.InvestorRecordsApi ( string basePath )

inline

Initializes a new instance of the InvestorRecordsApi class.

Returns

◆ InvestorRecordsApi() [3/4]

Lusid.Sdk.Api.InvestorRecordsApi.InvestorRecordsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the InvestorRecordsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ InvestorRecordsApi() [4/4]

Lusid.Sdk.Api.InvestorRecordsApi.InvestorRecordsApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the InvestorRecordsApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ DeleteInvestorRecord()

DeletedEntityResponse Lusid.Sdk.Api.InvestorRecordsApi.DeleteInvestorRecord	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record 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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ DeleteInvestorRecordAccessMetadata()

DeletedEntityResponse Lusid.Sdk.Api.InvestorRecordsApi.DeleteInvestorRecordAccessMetadata	(	string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. 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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to delete
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	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 (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ DeleteInvestorRecordAccessMetadataAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.InvestorRecordsApi.DeleteInvestorRecordAccessMetadataAsync	(	string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. 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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to delete
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	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 (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ DeleteInvestorRecordAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.InvestorRecordsApi.DeleteInvestorRecordAccessMetadataWithHttpInfo	(	string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. 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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to delete
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	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 (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ DeleteInvestorRecordAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.InvestorRecordsApi.DeleteInvestorRecordAccessMetadataWithHttpInfoAsync	(	string	identifierType,
		string	identifierValue,
		string	metadataKey,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteInvestorRecordAccessMetadata: Delete an Investor Record Access Metadata entry. 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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to delete
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	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 (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ DeleteInvestorRecordAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.InvestorRecordsApi.DeleteInvestorRecordAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record 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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ DeleteInvestorRecordWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.InvestorRecordsApi.DeleteInvestorRecordWithHttpInfo	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record 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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ DeleteInvestorRecordWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.InvestorRecordsApi.DeleteInvestorRecordWithHttpInfoAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] DeleteInvestorRecord: Delete Investor Record 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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ GetAllInvestorRecordAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.InvestorRecordsApi.GetAllInvestorRecordAccessMetadata	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ GetAllInvestorRecordAccessMetadataAsync()

async System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.InvestorRecordsApi.GetAllInvestorRecordAccessMetadataAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ GetAllInvestorRecordAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.InvestorRecordsApi.GetAllInvestorRecordAccessMetadataWithHttpInfo	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ GetAllInvestorRecordAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.InvestorRecordsApi.GetAllInvestorRecordAccessMetadataWithHttpInfoAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllInvestorRecordAccessMetadata: Get Access Metadata rules for an Investor Record. Pass the Scope and Code of the Investor Record identifier along with the identifier value parameter to retrieve the associated Access Metadata.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.InvestorRecordsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

◆ GetInvestorRecord()

InvestorRecord Lusid.Sdk.Api.InvestorRecordsApi.GetInvestorRecord	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		List< string >?	propertyKeys = `default(List<string>?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	relationshipDefinitionIds = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetInvestorRecord: Get Investor Record Retrieve the definition of a investor record.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
propertyKeys	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". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the investor record. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the investor record. Defaults to return the latest version of the investor record if not specified. (optional)
relationshipDefinitionIds	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}. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: InvestorRecord

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ GetInvestorRecordAsync()

async System.Threading.Tasks.Task<InvestorRecord> Lusid.Sdk.Api.InvestorRecordsApi.GetInvestorRecordAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		List< string >?	propertyKeys = `default(List<string>?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	relationshipDefinitionIds = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetInvestorRecord: Get Investor Record Retrieve the definition of a investor record.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
propertyKeys	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". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the investor record. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the investor record. Defaults to return the latest version of the investor record if not specified. (optional)
relationshipDefinitionIds	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}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of InvestorRecord

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ GetInvestorRecordRelationships()

ResourceListOfRelationship Lusid.Sdk.Api.InvestorRecordsApi.GetInvestorRecordRelationships	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships Get relationships for a particular Investor Record.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	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. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfRelationship

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ GetInvestorRecordRelationshipsAsync()

async System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.InvestorRecordsApi.GetInvestorRecordRelationshipsAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships Get relationships for a particular Investor Record.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfRelationship

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ GetInvestorRecordRelationshipsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> Lusid.Sdk.Api.InvestorRecordsApi.GetInvestorRecordRelationshipsWithHttpInfo	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships Get relationships for a particular Investor Record.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	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. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfRelationship

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ GetInvestorRecordRelationshipsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> > Lusid.Sdk.Api.InvestorRecordsApi.GetInvestorRecordRelationshipsWithHttpInfoAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetInvestorRecordRelationships: Get Investor Record relationships Get relationships for a particular Investor Record.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfRelationship)

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ GetInvestorRecordWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<InvestorRecord> Lusid.Sdk.Api.InvestorRecordsApi.GetInvestorRecordWithHttpInfo	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		List< string >?	propertyKeys = `default(List<string>?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	relationshipDefinitionIds = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetInvestorRecord: Get Investor Record Retrieve the definition of a investor record.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
propertyKeys	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". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the investor record. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the investor record. Defaults to return the latest version of the investor record if not specified. (optional)
relationshipDefinitionIds	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}. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of InvestorRecord

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ GetInvestorRecordWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<InvestorRecord> > Lusid.Sdk.Api.InvestorRecordsApi.GetInvestorRecordWithHttpInfoAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		List< string >?	propertyKeys = `default(List<string>?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	relationshipDefinitionIds = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetInvestorRecord: Get Investor Record Retrieve the definition of a investor record.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
propertyKeys	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". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the investor record. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the investor record. Defaults to return the latest version of the investor record if not specified. (optional)
relationshipDefinitionIds	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}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (InvestorRecord)

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ ListAllInvestorRecords()

ResourceListOfInvestorRecord Lusid.Sdk.Api.InvestorRecordsApi.ListAllInvestorRecords	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		List< string >?	relationshipDefinitionIds = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListAllInvestorRecords: List Investor Records List all investor records which the user is entitled to see.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to list the investor records. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the investor records. Defaults to return the latest version of each investor records if not specified. (optional)
page	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. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	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". (optional)
relationshipDefinitionIds	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}. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfInvestorRecord

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ ListAllInvestorRecordsAsync()

async System.Threading.Tasks.Task<ResourceListOfInvestorRecord> Lusid.Sdk.Api.InvestorRecordsApi.ListAllInvestorRecordsAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		List< string >?	relationshipDefinitionIds = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListAllInvestorRecords: List Investor Records List all investor records which the user is entitled to see.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to list the investor records. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the investor records. Defaults to return the latest version of each investor records if not specified. (optional)
page	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. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	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". (optional)
relationshipDefinitionIds	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}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfInvestorRecord

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ ListAllInvestorRecordsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfInvestorRecord> Lusid.Sdk.Api.InvestorRecordsApi.ListAllInvestorRecordsWithHttpInfo	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		List< string >?	relationshipDefinitionIds = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListAllInvestorRecords: List Investor Records List all investor records which the user is entitled to see.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to list the investor records. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the investor records. Defaults to return the latest version of each investor records if not specified. (optional)
page	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. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	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". (optional)
relationshipDefinitionIds	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}. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfInvestorRecord

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ ListAllInvestorRecordsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfInvestorRecord> > Lusid.Sdk.Api.InvestorRecordsApi.ListAllInvestorRecordsWithHttpInfoAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		List< string >?	relationshipDefinitionIds = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] ListAllInvestorRecords: List Investor Records List all investor records which the user is entitled to see.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to list the investor records. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the investor records. Defaults to return the latest version of each investor records if not specified. (optional)
page	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. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	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". (optional)
relationshipDefinitionIds	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}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfInvestorRecord)

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ PatchInvestorRecordAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.InvestorRecordsApi.PatchInvestorRecordAccessMetadata	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		List< AccessMetadataOperation >	accessMetadataOperation,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. 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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
accessMetadataOperation	The Json Patch document
effectiveAt	The effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntil	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 (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ PatchInvestorRecordAccessMetadataAsync()

async System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.InvestorRecordsApi.PatchInvestorRecordAccessMetadataAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		List< AccessMetadataOperation >	accessMetadataOperation,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. 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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
accessMetadataOperation	The Json Patch document
effectiveAt	The effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntil	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 (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ PatchInvestorRecordAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.InvestorRecordsApi.PatchInvestorRecordAccessMetadataWithHttpInfo	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		List< AccessMetadataOperation >	accessMetadataOperation,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. 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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
accessMetadataOperation	The Json Patch document
effectiveAt	The effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntil	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 (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ PatchInvestorRecordAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.InvestorRecordsApi.PatchInvestorRecordAccessMetadataWithHttpInfoAsync	(	string	identifierType,
		string	identifierValue,
		string	scope,
		string	identifierScope,
		List< AccessMetadataOperation >	accessMetadataOperation,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] PatchInvestorRecordAccessMetadata: Patch Access Metadata rules for an Investor Record. 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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

identifierType	Code of the investor record identifier type.
identifierValue	Code of the investor record under specified identifier type's scope and code.
scope	The scope of the investor record entity.
identifierScope	Scope of the investor record identifier type.
accessMetadataOperation	The Json Patch document
effectiveAt	The effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntil	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 (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ UpsertInvestorRecords()

UpsertInvestorRecordsResponse Lusid.Sdk.Api.InvestorRecordsApi.UpsertInvestorRecords	(	string	successMode,
		Dictionary< string, UpsertInvestorRecordRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records Creates or updates a collection of Investor Records

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBody	A collection of requests to create or update Investor Records.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: UpsertInvestorRecordsResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ UpsertInvestorRecordsAsync()

async System.Threading.Tasks.Task<UpsertInvestorRecordsResponse> Lusid.Sdk.Api.InvestorRecordsApi.UpsertInvestorRecordsAsync	(	string	successMode,
		Dictionary< string, UpsertInvestorRecordRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records Creates or updates a collection of Investor Records

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBody	A collection of requests to create or update Investor Records.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of UpsertInvestorRecordsResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

◆ UpsertInvestorRecordsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertInvestorRecordsResponse> Lusid.Sdk.Api.InvestorRecordsApi.UpsertInvestorRecordsWithHttpInfo	(	string	successMode,
		Dictionary< string, UpsertInvestorRecordRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records Creates or updates a collection of Investor Records

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBody	A collection of requests to create or update Investor Records.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of UpsertInvestorRecordsResponse

Implements Lusid.Sdk.Api.IInvestorRecordsApiSync.

◆ UpsertInvestorRecordsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertInvestorRecordsResponse> > Lusid.Sdk.Api.InvestorRecordsApi.UpsertInvestorRecordsWithHttpInfoAsync	(	string	successMode,
		Dictionary< string, UpsertInvestorRecordRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] UpsertInvestorRecords: Upsert investor records Creates or updates a collection of Investor Records

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBody	A collection of requests to create or update Investor Records.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (UpsertInvestorRecordsResponse)

Implements Lusid.Sdk.Api.IInvestorRecordsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.InvestorRecordsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.InvestorRecordsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.InvestorRecordsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.InvestorRecordsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/InvestorRecordsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InvestorRecordsApi() [1/4]

◆ InvestorRecordsApi() [2/4]

◆ InvestorRecordsApi() [3/4]

◆ InvestorRecordsApi() [4/4]

Member Function Documentation

◆ DeleteInvestorRecord()

◆ DeleteInvestorRecordAccessMetadata()

◆ DeleteInvestorRecordAccessMetadataAsync()

◆ DeleteInvestorRecordAccessMetadataWithHttpInfo()

◆ DeleteInvestorRecordAccessMetadataWithHttpInfoAsync()

◆ DeleteInvestorRecordAsync()

◆ DeleteInvestorRecordWithHttpInfo()

◆ DeleteInvestorRecordWithHttpInfoAsync()

◆ GetAllInvestorRecordAccessMetadata()

◆ GetAllInvestorRecordAccessMetadataAsync()

◆ GetAllInvestorRecordAccessMetadataWithHttpInfo()

◆ GetAllInvestorRecordAccessMetadataWithHttpInfoAsync()

◆ GetBasePath()

◆ GetInvestorRecord()

◆ GetInvestorRecordAsync()

◆ GetInvestorRecordRelationships()

◆ GetInvestorRecordRelationshipsAsync()

◆ GetInvestorRecordRelationshipsWithHttpInfo()

◆ GetInvestorRecordRelationshipsWithHttpInfoAsync()

◆ GetInvestorRecordWithHttpInfo()

◆ GetInvestorRecordWithHttpInfoAsync()

◆ ListAllInvestorRecords()

◆ ListAllInvestorRecordsAsync()

◆ ListAllInvestorRecordsWithHttpInfo()

◆ ListAllInvestorRecordsWithHttpInfoAsync()

◆ PatchInvestorRecordAccessMetadata()

◆ PatchInvestorRecordAccessMetadataAsync()

◆ PatchInvestorRecordAccessMetadataWithHttpInfo()

◆ PatchInvestorRecordAccessMetadataWithHttpInfoAsync()

◆ UpsertInvestorRecords()

◆ UpsertInvestorRecordsAsync()

◆ UpsertInvestorRecordsWithHttpInfo()

◆ UpsertInvestorRecordsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory