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

Inheritance diagram for Lusid.Sdk.Api.ICustomEntityTypesApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< CustomEntityType >	CreateCustomEntityTypeAsync (CreateCustomEntityTypeRequest createCustomEntityTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateCustomEntityType: Define a new Custom Entity Type. More...

System.Threading.Tasks.Task< ApiResponse< CustomEntityType > >	CreateCustomEntityTypeWithHttpInfoAsync (CreateCustomEntityTypeRequest createCustomEntityTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateCustomEntityType: Define a new Custom Entity Type. More...

System.Threading.Tasks.Task< CustomEntityType >	GetCustomEntityTypeAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. More...

System.Threading.Tasks.Task< ApiResponse< CustomEntityType > >	GetCustomEntityTypeWithHttpInfoAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type. More...

System.Threading.Tasks.Task< PagedResourceListOfCustomEntityType >	ListCustomEntityTypesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfCustomEntityType > >	ListCustomEntityTypesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types. More...

System.Threading.Tasks.Task< CustomEntityType >	UpdateCustomEntityTypeAsync (string entityType, UpdateCustomEntityTypeRequest updateCustomEntityTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateCustomEntityType: Modify an existing Custom Entity Type. More...

System.Threading.Tasks.Task< ApiResponse< CustomEntityType > >	UpdateCustomEntityTypeWithHttpInfoAsync (string entityType, UpdateCustomEntityTypeRequest updateCustomEntityTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateCustomEntityType: Modify an existing Custom Entity Type. 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

◆ CreateCustomEntityTypeAsync()

System.Threading.Tasks.Task<CustomEntityType> Lusid.Sdk.Api.ICustomEntityTypesApiAsync.CreateCustomEntityTypeAsync	(	CreateCustomEntityTypeRequest	createCustomEntityTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] CreateCustomEntityType: Define a new Custom Entity Type.

The API will return a Bad Request if the Custom Entity Type already exists.

Exceptions

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

Parameters

createCustomEntityTypeRequest	The payload containing the description of the Custom Entity Type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CustomEntityType

Implemented in Lusid.Sdk.Api.CustomEntityTypesApi.

◆ CreateCustomEntityTypeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustomEntityType> > Lusid.Sdk.Api.ICustomEntityTypesApiAsync.CreateCustomEntityTypeWithHttpInfoAsync	(	CreateCustomEntityTypeRequest	createCustomEntityTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] CreateCustomEntityType: Define a new Custom Entity Type.

The API will return a Bad Request if the Custom Entity Type already exists.

Exceptions

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

Parameters

createCustomEntityTypeRequest	The payload containing the description of the Custom Entity Type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CustomEntityType)

Implemented in Lusid.Sdk.Api.CustomEntityTypesApi.

◆ GetCustomEntityTypeAsync()

System.Threading.Tasks.Task<CustomEntityType> Lusid.Sdk.Api.ICustomEntityTypesApiAsync.GetCustomEntityTypeAsync	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type.

Retrieve a specific Custom Entity Type at a point in AsAt time.

Exceptions

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

Parameters

entityType	The identifier for the Custom Entity Type, derived from the "entityTypeName" provided on creation.
asAt	The AsAt datetime at which to retrieve the definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CustomEntityType

Implemented in Lusid.Sdk.Api.CustomEntityTypesApi.

◆ GetCustomEntityTypeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustomEntityType> > Lusid.Sdk.Api.ICustomEntityTypesApiAsync.GetCustomEntityTypeWithHttpInfoAsync	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type.

Retrieve a specific Custom Entity Type at a point in AsAt time.

Exceptions

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

Parameters

entityType	The identifier for the Custom Entity Type, derived from the "entityTypeName" provided on creation.
asAt	The AsAt datetime at which to retrieve the definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CustomEntityType)

Implemented in Lusid.Sdk.Api.CustomEntityTypesApi.

◆ ListCustomEntityTypesAsync()

System.Threading.Tasks.Task<PagedResourceListOfCustomEntityType> Lusid.Sdk.Api.ICustomEntityTypesApiAsync.ListCustomEntityTypesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types.

List all Custom Entity Types matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type if not specified. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit, sortBy, and asAt fields must not have changed since the original request. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfCustomEntityType

Implemented in Lusid.Sdk.Api.CustomEntityTypesApi.

◆ ListCustomEntityTypesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfCustomEntityType> > Lusid.Sdk.Api.ICustomEntityTypesApiAsync.ListCustomEntityTypesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types.

List all Custom Entity Types matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type if not specified. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit, sortBy, and asAt fields must not have changed since the original request. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfCustomEntityType)

Implemented in Lusid.Sdk.Api.CustomEntityTypesApi.

◆ UpdateCustomEntityTypeAsync()

System.Threading.Tasks.Task<CustomEntityType> Lusid.Sdk.Api.ICustomEntityTypesApiAsync.UpdateCustomEntityTypeAsync	(	string	entityType,
		UpdateCustomEntityTypeRequest	updateCustomEntityTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpdateCustomEntityType: Modify an existing Custom Entity Type.

The API will return a Bad Request if the Custom Entity Type does not exist.

Exceptions

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

Parameters

entityType	The identifier for the Custom Entity Type, derived from the "entityTypeName" provided on creation.
updateCustomEntityTypeRequest	The payload containing the description of the Custom Entity Type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CustomEntityType

Implemented in Lusid.Sdk.Api.CustomEntityTypesApi.

◆ UpdateCustomEntityTypeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CustomEntityType> > Lusid.Sdk.Api.ICustomEntityTypesApiAsync.UpdateCustomEntityTypeWithHttpInfoAsync	(	string	entityType,
		UpdateCustomEntityTypeRequest	updateCustomEntityTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpdateCustomEntityType: Modify an existing Custom Entity Type.

The API will return a Bad Request if the Custom Entity Type does not exist.

Exceptions

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

Parameters

entityType	The identifier for the Custom Entity Type, derived from the "entityTypeName" provided on creation.
updateCustomEntityTypeRequest	The payload containing the description of the Custom Entity Type.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CustomEntityType)

Implemented in Lusid.Sdk.Api.CustomEntityTypesApi.

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/CustomEntityTypesApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateCustomEntityTypeAsync()

◆ CreateCustomEntityTypeWithHttpInfoAsync()

◆ GetCustomEntityTypeAsync()

◆ GetCustomEntityTypeWithHttpInfoAsync()

◆ ListCustomEntityTypesAsync()

◆ ListCustomEntityTypesWithHttpInfoAsync()

◆ UpdateCustomEntityTypeAsync()

◆ UpdateCustomEntityTypeWithHttpInfoAsync()