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

Inheritance diagram for Lusid.Sdk.Api.ILegalEntitiesApiSync:

Public Member Functions
DeletedEntityResponse	DeleteLegalEntity (string idTypeScope, string idTypeCode, string code)
	[EARLY ACCESS] Delete Legal Entity More...

ApiResponse< DeletedEntityResponse >	DeleteLegalEntityWithHttpInfo (string idTypeScope, string idTypeCode, string code)
	[EARLY ACCESS] Delete Legal Entity 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 More...

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

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

LegalEntity	UpsertLegalEntity (UpsertLegalEntityRequest upsertLegalEntityRequest)
	[EARLY ACCESS] Upsert Legal Entity More...

ApiResponse< LegalEntity >	UpsertLegalEntityWithHttpInfo (UpsertLegalEntityRequest upsertLegalEntityRequest)
	[EARLY ACCESS] Upsert Legal Entity More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
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

Member Function Documentation

◆ DeleteLegalEntity()

DeletedEntityResponse Lusid.Sdk.Api.ILegalEntitiesApiSync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ DeleteLegalEntityWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ILegalEntitiesApiSync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntity()

LegalEntity Lusid.Sdk.Api.ILegalEntitiesApiSync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityWithHttpInfo()

ApiResponse<LegalEntity> Lusid.Sdk.Api.ILegalEntitiesApiSync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ ListLegalEntities()

PagedResourceListOfLegalEntity Lusid.Sdk.Api.ILegalEntitiesApiSync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ ListLegalEntitiesWithHttpInfo()

ApiResponse<PagedResourceListOfLegalEntity> Lusid.Sdk.Api.ILegalEntitiesApiSync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ UpsertLegalEntity()

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

[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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ UpsertLegalEntityWithHttpInfo()

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

[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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

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

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteLegalEntity()

◆ DeleteLegalEntityWithHttpInfo()

◆ GetLegalEntity()

◆ GetLegalEntityWithHttpInfo()

◆ ListLegalEntities()

◆ ListLegalEntitiesWithHttpInfo()

◆ UpsertLegalEntity()

◆ UpsertLegalEntityWithHttpInfo()