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

Inheritance diagram for Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync:

Public Member Functions
System.Threading.Tasks.Task< CutLabelDefinition >	CreateCutLabelDefinitionAsync (CreateCutLabelDefinitionRequest createCutLabelDefinitionRequest=default(CreateCutLabelDefinitionRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create a Cut Label More...

System.Threading.Tasks.Task< ApiResponse< CutLabelDefinition > >	CreateCutLabelDefinitionWithHttpInfoAsync (CreateCutLabelDefinitionRequest createCutLabelDefinitionRequest=default(CreateCutLabelDefinitionRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create a Cut Label More...

System.Threading.Tasks.Task< DateTimeOffset >	DeleteCutLabelDefinitionAsync (string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete a Cut Label More...

System.Threading.Tasks.Task< ApiResponse< DateTimeOffset > >	DeleteCutLabelDefinitionWithHttpInfoAsync (string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete a Cut Label More...

System.Threading.Tasks.Task< CutLabelDefinition >	GetCutLabelDefinitionAsync (string code, DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get a Cut Label More...

System.Threading.Tasks.Task< ApiResponse< CutLabelDefinition > >	GetCutLabelDefinitionWithHttpInfoAsync (string code, DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get a Cut Label More...

System.Threading.Tasks.Task< PagedResourceListOfCutLabelDefinition >	ListCutLabelDefinitionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List Existing Cut Labels More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfCutLabelDefinition > >	ListCutLabelDefinitionsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List Existing Cut Labels More...

System.Threading.Tasks.Task< CutLabelDefinition >	UpdateCutLabelDefinitionAsync (string code, UpdateCutLabelDefinitionRequest updateCutLabelDefinitionRequest=default(UpdateCutLabelDefinitionRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Update a Cut Label More...

System.Threading.Tasks.Task< ApiResponse< CutLabelDefinition > >	UpdateCutLabelDefinitionWithHttpInfoAsync (string code, UpdateCutLabelDefinitionRequest updateCutLabelDefinitionRequest=default(UpdateCutLabelDefinitionRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Update a Cut Label 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

◆ CreateCutLabelDefinitionAsync()

System.Threading.Tasks.Task<CutLabelDefinition> Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.CreateCutLabelDefinitionAsync	(	CreateCutLabelDefinitionRequest	createCutLabelDefinitionRequest = `default(CreateCutLabelDefinitionRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Create a Cut Label

Create a Cut Label valid in all scopes

Exceptions

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

Parameters

createCutLabelDefinitionRequest	The cut label definition (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CutLabelDefinition

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ CreateCutLabelDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CutLabelDefinition> > Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.CreateCutLabelDefinitionWithHttpInfoAsync	(	CreateCutLabelDefinitionRequest	createCutLabelDefinitionRequest = `default(CreateCutLabelDefinitionRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Create a Cut Label

Create a Cut Label valid in all scopes

Exceptions

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

Parameters

createCutLabelDefinitionRequest	The cut label definition (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CutLabelDefinition)

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ DeleteCutLabelDefinitionAsync()

System.Threading.Tasks.Task<DateTimeOffset> Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.DeleteCutLabelDefinitionAsync	(	string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete a Cut Label

Delete a specified cut label

Exceptions

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

Parameters

code	The Code of the Cut Label that is being Deleted
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DateTimeOffset

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ DeleteCutLabelDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DateTimeOffset> > Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.DeleteCutLabelDefinitionWithHttpInfoAsync	(	string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete a Cut Label

Delete a specified cut label

Exceptions

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

Parameters

code	The Code of the Cut Label that is being Deleted
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DateTimeOffset)

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ GetCutLabelDefinitionAsync()

System.Threading.Tasks.Task<CutLabelDefinition> Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.GetCutLabelDefinitionAsync	(	string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get a Cut Label

Get a specified cut label at a given time

Exceptions

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

Parameters

code	The Code of the Cut Label that is being queried
asAt	The time at which to get the Cut Label (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CutLabelDefinition

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ GetCutLabelDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CutLabelDefinition> > Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.GetCutLabelDefinitionWithHttpInfoAsync	(	string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get a Cut Label

Get a specified cut label at a given time

Exceptions

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

Parameters

code	The Code of the Cut Label that is being queried
asAt	The time at which to get the Cut Label (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CutLabelDefinition)

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ ListCutLabelDefinitionsAsync()

System.Threading.Tasks.Task<PagedResourceListOfCutLabelDefinition> Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.ListCutLabelDefinitionsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	sortBy = `default(List< string >)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] List Existing Cut Labels

List all the Cut Label Definitions that are valid at the given AsAt time

Exceptions

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

Parameters

asAt	Optional. The As At time at which listed Cut Labels are valid (optional)
sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
start	Optional. When paginating, skip this number of results (optional)
limit	Optional. When paginating, limit the number of returned results to this many. (optional)
filter	Optional. Expression to filter the result set. For example, to filter on code, use "code eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
page	The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfCutLabelDefinition

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ ListCutLabelDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfCutLabelDefinition> > Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.ListCutLabelDefinitionsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	sortBy = `default(List< string >)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] List Existing Cut Labels

List all the Cut Label Definitions that are valid at the given AsAt time

Exceptions

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

Parameters

asAt	Optional. The As At time at which listed Cut Labels are valid (optional)
sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
start	Optional. When paginating, skip this number of results (optional)
limit	Optional. When paginating, limit the number of returned results to this many. (optional)
filter	Optional. Expression to filter the result set. For example, to filter on code, use "code eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
page	The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfCutLabelDefinition)

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ UpdateCutLabelDefinitionAsync()

System.Threading.Tasks.Task<CutLabelDefinition> Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.UpdateCutLabelDefinitionAsync	(	string	code,
		UpdateCutLabelDefinitionRequest	updateCutLabelDefinitionRequest = `default(UpdateCutLabelDefinitionRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Update a Cut Label

Update a specified cut label

Exceptions

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

Parameters

code	The Code of the Cut Label that is being updated
updateCutLabelDefinitionRequest	The cut label update definition (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CutLabelDefinition

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

◆ UpdateCutLabelDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CutLabelDefinition> > Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.UpdateCutLabelDefinitionWithHttpInfoAsync	(	string	code,
		UpdateCutLabelDefinitionRequest	updateCutLabelDefinitionRequest = `default(UpdateCutLabelDefinitionRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Update a Cut Label

Update a specified cut label

Exceptions

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

Parameters

code	The Code of the Cut Label that is being updated
updateCutLabelDefinitionRequest	The cut label update definition (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CutLabelDefinition)

Implemented in Lusid.Sdk.Api.CutLabelDefinitionsApi.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateCutLabelDefinitionAsync()

◆ CreateCutLabelDefinitionWithHttpInfoAsync()

◆ DeleteCutLabelDefinitionAsync()

◆ DeleteCutLabelDefinitionWithHttpInfoAsync()

◆ GetCutLabelDefinitionAsync()

◆ GetCutLabelDefinitionWithHttpInfoAsync()

◆ ListCutLabelDefinitionsAsync()

◆ ListCutLabelDefinitionsWithHttpInfoAsync()

◆ UpdateCutLabelDefinitionAsync()

◆ UpdateCutLabelDefinitionWithHttpInfoAsync()