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

Inheritance diagram for Lusid.Sdk.Api.LegalEntitiesApi:

[legend]

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

	LegalEntitiesApi (String basePath)
	Initializes a new instance of the LegalEntitiesApi class. More...

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

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

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

DeletedEntityResponse	DeleteLegalEntity (string idTypeScope, string idTypeCode, string code)
	[EARLY ACCESS] Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteLegalEntityWithHttpInfo (string idTypeScope, string idTypeCode, string code)
	[EARLY ACCESS] Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteLegalEntityAsync (string idTypeScope, string idTypeCode, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteLegalEntityWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. More...

LegalEntity	GetLegalEntity (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys=default(List< string >), DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get Legal Entity Retrieve the definition of a legal entity. More...

Lusid.Sdk.Client.ApiResponse< LegalEntity >	GetLegalEntityWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys=default(List< string >), DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get Legal Entity Retrieve the definition of a legal entity. More...

async System.Threading.Tasks.Task< LegalEntity >	GetLegalEntityAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys=default(List< string >), DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get Legal Entity Retrieve the definition of a legal entity. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< LegalEntity > >	GetLegalEntityWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys=default(List< string >), DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get Legal Entity Retrieve the definition of a legal entity. More...

PagedResourceListOfLegalEntity	ListLegalEntities (string idTypeScope, string idTypeCode, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >))
	[EARLY ACCESS] List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfLegalEntity >	ListLegalEntitiesWithHttpInfo (string idTypeScope, string idTypeCode, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >))
	[EARLY ACCESS] List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria. More...

async System.Threading.Tasks.Task< PagedResourceListOfLegalEntity >	ListLegalEntitiesAsync (string idTypeScope, string idTypeCode, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfLegalEntity > >	ListLegalEntitiesWithHttpInfoAsync (string idTypeScope, string idTypeCode, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria. More...

LegalEntity	UpsertLegalEntity (UpsertLegalEntityRequest upsertLegalEntityRequest)
	[EARLY ACCESS] Upsert Legal Entity Create or update a legal entity More...

Lusid.Sdk.Client.ApiResponse< LegalEntity >	UpsertLegalEntityWithHttpInfo (UpsertLegalEntityRequest upsertLegalEntityRequest)
	[EARLY ACCESS] Upsert Legal Entity Create or update a legal entity More...

async System.Threading.Tasks.Task< LegalEntity >	UpsertLegalEntityAsync (UpsertLegalEntityRequest upsertLegalEntityRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Upsert Legal Entity Create or update a legal entity More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< LegalEntity > >	UpsertLegalEntityWithHttpInfoAsync (UpsertLegalEntityRequest upsertLegalEntityRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Upsert Legal Entity Create or update a legal entity 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...

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

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

◆ LegalEntitiesApi() [1/4]

Lusid.Sdk.Api.LegalEntitiesApi.LegalEntitiesApi ( )

inline

Initializes a new instance of the LegalEntitiesApi class.

Returns

◆ LegalEntitiesApi() [2/4]

Lusid.Sdk.Api.LegalEntitiesApi.LegalEntitiesApi ( String basePath )

inline

Initializes a new instance of the LegalEntitiesApi class.

Returns

◆ LegalEntitiesApi() [3/4]

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

inline

Initializes a new instance of the LegalEntitiesApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ LegalEntitiesApi() [4/4]

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

inline

Initializes a new instance of the LegalEntitiesApi 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

◆ DeleteLegalEntity()

DeletedEntityResponse Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntity	(	string	idTypeScope,
		string	idTypeCode,
		string	code
	)

inline

[EARLY ACCESS] Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

idTypeScope	The scope of the legal entity identifier type.
idTypeCode	The code of the legal entity identifier type.
code	Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityAsync	(	string	idTypeScope,
		string	idTypeCode,
		string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

idTypeScope	The scope of the legal entity identifier type.
idTypeCode	The code of the legal entity identifier type.
code	Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ DeleteLegalEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityWithHttpInfo	(	string	idTypeScope,
		string	idTypeCode,
		string	code
	)

inline

[EARLY ACCESS] Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

idTypeScope	The scope of the legal entity identifier type.
idTypeCode	The code of the legal entity identifier type.
code	Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityWithHttpInfoAsync	(	string	idTypeScope,
		string	idTypeCode,
		string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

idTypeScope	The scope of the legal entity identifier type.
idTypeCode	The code of the legal entity identifier type.
code	Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetBasePath()

String Lusid.Sdk.Api.LegalEntitiesApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetLegalEntity()

LegalEntity Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntity	(	string	idTypeScope,
		string	idTypeCode,
		string	code,
		List< string >	propertyKeys = `default(List<string>)`,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

[EARLY ACCESS] Get Legal Entity Retrieve the definition of a legal entity.

Exceptions

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

Parameters

idTypeScope	Scope of the legal entity identifier type.
idTypeCode	Code of the legal entity identifier type.
code	Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeys	A list of property keys or identifier types (as property keys) from the "LegalEntity" domain to include for found legal entity. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional)

Returns: LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityAsync()

async System.Threading.Tasks.Task<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityAsync	(	string	idTypeScope,
		string	idTypeCode,
		string	code,
		List< string >	propertyKeys = `default(List<string>)`,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Get Legal Entity Retrieve the definition of a legal entity.

Exceptions

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

Parameters

idTypeScope	Scope of the legal entity identifier type.
idTypeCode	Code of the legal entity identifier type.
code	Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeys	A list of property keys or identifier types (as property keys) from the "LegalEntity" domain to include for found legal entity. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityWithHttpInfo	(	string	idTypeScope,
		string	idTypeCode,
		string	code,
		List< string >	propertyKeys = `default(List<string>)`,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

[EARLY ACCESS] Get Legal Entity Retrieve the definition of a legal entity.

Exceptions

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

Parameters

idTypeScope	Scope of the legal entity identifier type.
idTypeCode	Code of the legal entity identifier type.
code	Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeys	A list of property keys or identifier types (as property keys) from the "LegalEntity" domain to include for found legal entity. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional)

Returns: ApiResponse of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<LegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityWithHttpInfoAsync	(	string	idTypeScope,
		string	idTypeCode,
		string	code,
		List< string >	propertyKeys = `default(List<string>)`,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Get Legal Entity Retrieve the definition of a legal entity.

Exceptions

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

Parameters

idTypeScope	Scope of the legal entity identifier type.
idTypeCode	Code of the legal entity identifier type.
code	Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeys	A list of property keys or identifier types (as property keys) from the "LegalEntity" domain to include for found legal entity. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (LegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ ListLegalEntities()

PagedResourceListOfLegalEntity Lusid.Sdk.Api.LegalEntitiesApi.ListLegalEntities	(	string	idTypeScope,
		string	idTypeCode,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List<string>)`
	)

inline

[EARLY ACCESS] List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria.

Exceptions

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

Parameters

idTypeScope	Scope of the legal entity identifier type.
idTypeCode	Code of the legal entity identifier type.
effectiveAt	The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
page	The pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt 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 65,535 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)
propertyKeys	A list of property keys or identifier types (as property keys) from the "LegalEntity" domain to include for each legal entity. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". (optional)

Returns: PagedResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ ListLegalEntitiesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfLegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.ListLegalEntitiesAsync	(	string	idTypeScope,
		string	idTypeCode,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List<string>)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria.

Exceptions

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

Parameters

idTypeScope	Scope of the legal entity identifier type.
idTypeCode	Code of the legal entity identifier type.
effectiveAt	The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
page	The pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt 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 65,535 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)
propertyKeys	A list of property keys or identifier types (as property keys) from the "LegalEntity" domain to include for each legal entity. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ ListLegalEntitiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfLegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.ListLegalEntitiesWithHttpInfo	(	string	idTypeScope,
		string	idTypeCode,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List<string>)`
	)

inline

[EARLY ACCESS] List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria.

Exceptions

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

Parameters

idTypeScope	Scope of the legal entity identifier type.
idTypeCode	Code of the legal entity identifier type.
effectiveAt	The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
page	The pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt 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 65,535 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)
propertyKeys	A list of property keys or identifier types (as property keys) from the "LegalEntity" domain to include for each legal entity. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". (optional)

Returns: ApiResponse of PagedResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ ListLegalEntitiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfLegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.ListLegalEntitiesWithHttpInfoAsync	(	string	idTypeScope,
		string	idTypeCode,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List<string>)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria.

Exceptions

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

Parameters

idTypeScope	Scope of the legal entity identifier type.
idTypeCode	Code of the legal entity identifier type.
effectiveAt	The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
page	The pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt 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 65,535 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)
propertyKeys	A list of property keys or identifier types (as property keys) from the "LegalEntity" domain to include for each legal entity. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfLegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ UpsertLegalEntity()

LegalEntity Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntity ( UpsertLegalEntityRequest upsertLegalEntityRequest )

inline

[EARLY ACCESS] Upsert Legal Entity Create or update a legal entity

Exceptions

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

Parameters

upsertLegalEntityRequest Request to create or update a legal entity.

Returns: LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ UpsertLegalEntityAsync()

async System.Threading.Tasks.Task<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityAsync	(	UpsertLegalEntityRequest	upsertLegalEntityRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Upsert Legal Entity Create or update a legal entity

Exceptions

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

Parameters

upsertLegalEntityRequest	Request to create or update a legal entity.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ UpsertLegalEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityWithHttpInfo ( UpsertLegalEntityRequest upsertLegalEntityRequest )

inline

[EARLY ACCESS] Upsert Legal Entity Create or update a legal entity

Exceptions

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

Parameters

upsertLegalEntityRequest Request to create or update a legal entity.

Returns: ApiResponse of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ UpsertLegalEntityWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<LegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityWithHttpInfoAsync	(	UpsertLegalEntityRequest	upsertLegalEntityRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Upsert Legal Entity Create or update a legal entity

Exceptions

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

Parameters

upsertLegalEntityRequest	Request to create or update a legal entity.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (LegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.LegalEntitiesApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.LegalEntitiesApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.LegalEntitiesApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.LegalEntitiesApi.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/stable/sdk/Lusid.Sdk/Api/LegalEntitiesApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ LegalEntitiesApi() [1/4]

◆ LegalEntitiesApi() [2/4]

◆ LegalEntitiesApi() [3/4]

◆ LegalEntitiesApi() [4/4]

Member Function Documentation

◆ DeleteLegalEntity()

◆ DeleteLegalEntityAsync()

◆ DeleteLegalEntityWithHttpInfo()

◆ DeleteLegalEntityWithHttpInfoAsync()

◆ GetBasePath()

◆ GetLegalEntity()

◆ GetLegalEntityAsync()

◆ GetLegalEntityWithHttpInfo()

◆ GetLegalEntityWithHttpInfoAsync()

◆ ListLegalEntities()

◆ ListLegalEntitiesAsync()

◆ ListLegalEntitiesWithHttpInfo()

◆ ListLegalEntitiesWithHttpInfoAsync()

◆ UpsertLegalEntity()

◆ UpsertLegalEntityAsync()

◆ UpsertLegalEntityWithHttpInfo()

◆ UpsertLegalEntityWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory