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

Inheritance diagram for Lusid.Sdk.Api.IInvestorRecordsApiAsync:

[legend]

Public Member Functions
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 More...

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 More...

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. More...

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. More...

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. More...

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. More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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. More...

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. More...

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 More...

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 More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteInvestorRecordAccessMetadataAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IInvestorRecordsApiAsync.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).

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

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ DeleteInvestorRecordAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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).

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)

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ DeleteInvestorRecordAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ DeleteInvestorRecordWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ GetAllInvestorRecordAccessMetadataAsync()

System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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>>

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ GetAllInvestorRecordAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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>>)

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ GetInvestorRecordAsync()

System.Threading.Tasks.Task<InvestorRecord> Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ GetInvestorRecordRelationshipsAsync()

System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ GetInvestorRecordRelationshipsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ GetInvestorRecordWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<InvestorRecord> > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ ListAllInvestorRecordsAsync()

System.Threading.Tasks.Task<ResourceListOfInvestorRecord> Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ ListAllInvestorRecordsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfInvestorRecord> > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ PatchInvestorRecordAccessMetadataAsync()

System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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>>

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ PatchInvestorRecordAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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.

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>>)

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ UpsertInvestorRecordsAsync()

System.Threading.Tasks.Task<UpsertInvestorRecordsResponse> Lusid.Sdk.Api.IInvestorRecordsApiAsync.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

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

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

◆ UpsertInvestorRecordsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertInvestorRecordsResponse> > Lusid.Sdk.Api.IInvestorRecordsApiAsync.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

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)

Implemented in Lusid.Sdk.Api.InvestorRecordsApi.

The documentation for this interface 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

Detailed Description

Member Function Documentation

◆ DeleteInvestorRecordAccessMetadataAsync()

◆ DeleteInvestorRecordAccessMetadataWithHttpInfoAsync()

◆ DeleteInvestorRecordAsync()

◆ DeleteInvestorRecordWithHttpInfoAsync()

◆ GetAllInvestorRecordAccessMetadataAsync()

◆ GetAllInvestorRecordAccessMetadataWithHttpInfoAsync()

◆ GetInvestorRecordAsync()

◆ GetInvestorRecordRelationshipsAsync()

◆ GetInvestorRecordRelationshipsWithHttpInfoAsync()

◆ GetInvestorRecordWithHttpInfoAsync()

◆ ListAllInvestorRecordsAsync()

◆ ListAllInvestorRecordsWithHttpInfoAsync()

◆ PatchInvestorRecordAccessMetadataAsync()

◆ PatchInvestorRecordAccessMetadataWithHttpInfoAsync()

◆ UpsertInvestorRecordsAsync()

◆ UpsertInvestorRecordsWithHttpInfoAsync()