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

Inheritance diagram for Lusid.Sdk.Api.CutLabelDefinitionsApi:

[legend]

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

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

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

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

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

CutLabelDefinition	CreateCutLabelDefinition (CreateCutLabelDefinitionRequest createCutLabelDefinitionRequest=default(CreateCutLabelDefinitionRequest))
	[EARLY ACCESS] Create a Cut Label Create a Cut Label valid in all scopes More...

Lusid.Sdk.Client.ApiResponse< CutLabelDefinition >	CreateCutLabelDefinitionWithHttpInfo (CreateCutLabelDefinitionRequest createCutLabelDefinitionRequest=default(CreateCutLabelDefinitionRequest))
	[EARLY ACCESS] Create a Cut Label Create a Cut Label valid in all scopes More...

async System.Threading.Tasks.Task< CutLabelDefinition >	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 More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CutLabelDefinition > >	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 More...

DateTimeOffset	DeleteCutLabelDefinition (string code)
	[EARLY ACCESS] Delete a Cut Label Delete a specified cut label More...

Lusid.Sdk.Client.ApiResponse< DateTimeOffset >	DeleteCutLabelDefinitionWithHttpInfo (string code)
	[EARLY ACCESS] Delete a Cut Label Delete a specified cut label More...

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

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

CutLabelDefinition	GetCutLabelDefinition (string code, DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get a Cut Label Get a specified cut label at a given time More...

Lusid.Sdk.Client.ApiResponse< CutLabelDefinition >	GetCutLabelDefinitionWithHttpInfo (string code, DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] Get a Cut Label Get a specified cut label at a given time More...

async 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 Get a specified cut label at a given time More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CutLabelDefinition > >	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 More...

PagedResourceListOfCutLabelDefinition	ListCutLabelDefinitions (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))
	[EARLY ACCESS] List Existing Cut Labels List all the Cut Label Definitions that are valid at the given AsAt time More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCutLabelDefinition >	ListCutLabelDefinitionsWithHttpInfo (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))
	[EARLY ACCESS] List Existing Cut Labels List all the Cut Label Definitions that are valid at the given AsAt time More...

async 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 List all the Cut Label Definitions that are valid at the given AsAt time More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the Cut Label Definitions that are valid at the given AsAt time More...

CutLabelDefinition	UpdateCutLabelDefinition (string code, UpdateCutLabelDefinitionRequest updateCutLabelDefinitionRequest=default(UpdateCutLabelDefinitionRequest))
	[EARLY ACCESS] Update a Cut Label Update a specified cut label More...

Lusid.Sdk.Client.ApiResponse< CutLabelDefinition >	UpdateCutLabelDefinitionWithHttpInfo (string code, UpdateCutLabelDefinitionRequest updateCutLabelDefinitionRequest=default(UpdateCutLabelDefinitionRequest))
	[EARLY ACCESS] Update a Cut Label Update a specified cut label More...

async 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 Update a specified cut label More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CutLabelDefinition > >	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 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

◆ CutLabelDefinitionsApi() [1/4]

Lusid.Sdk.Api.CutLabelDefinitionsApi.CutLabelDefinitionsApi ( )

inline

Initializes a new instance of the CutLabelDefinitionsApi class.

Returns

◆ CutLabelDefinitionsApi() [2/4]

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

inline

Initializes a new instance of the CutLabelDefinitionsApi class.

Returns

◆ CutLabelDefinitionsApi() [3/4]

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

inline

Initializes a new instance of the CutLabelDefinitionsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ CutLabelDefinitionsApi() [4/4]

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

inline

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

◆ CreateCutLabelDefinition()

CutLabelDefinition Lusid.Sdk.Api.CutLabelDefinitionsApi.CreateCutLabelDefinition ( CreateCutLabelDefinitionRequest createCutLabelDefinitionRequest = default(CreateCutLabelDefinitionRequest) )

inline

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

Returns: CutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ CreateCutLabelDefinitionAsync()

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

inline

[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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ CreateCutLabelDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CutLabelDefinition> Lusid.Sdk.Api.CutLabelDefinitionsApi.CreateCutLabelDefinitionWithHttpInfo ( CreateCutLabelDefinitionRequest createCutLabelDefinitionRequest = default(CreateCutLabelDefinitionRequest) )

inline

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

Returns: ApiResponse of CutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ CreateCutLabelDefinitionWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ DeleteCutLabelDefinition()

DateTimeOffset Lusid.Sdk.Api.CutLabelDefinitionsApi.DeleteCutLabelDefinition ( string code )

inline

[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

Returns: DateTimeOffset

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ DeleteCutLabelDefinitionAsync()

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

inline

[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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ DeleteCutLabelDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DateTimeOffset> Lusid.Sdk.Api.CutLabelDefinitionsApi.DeleteCutLabelDefinitionWithHttpInfo ( string code )

inline

[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

Returns: ApiResponse of DateTimeOffset

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ DeleteCutLabelDefinitionWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetCutLabelDefinition()

CutLabelDefinition Lusid.Sdk.Api.CutLabelDefinitionsApi.GetCutLabelDefinition	(	string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

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

Returns: CutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ GetCutLabelDefinitionAsync()

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

inline

[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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ GetCutLabelDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CutLabelDefinition> Lusid.Sdk.Api.CutLabelDefinitionsApi.GetCutLabelDefinitionWithHttpInfo	(	string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`
	)

inline

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

Returns: ApiResponse of CutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ GetCutLabelDefinitionWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ ListCutLabelDefinitions()

PagedResourceListOfCutLabelDefinition Lusid.Sdk.Api.CutLabelDefinitionsApi.ListCutLabelDefinitions	(	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)`
	)

inline

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

Returns: PagedResourceListOfCutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ ListCutLabelDefinitionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfCutLabelDefinition> Lusid.Sdk.Api.CutLabelDefinitionsApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ ListCutLabelDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCutLabelDefinition> Lusid.Sdk.Api.CutLabelDefinitionsApi.ListCutLabelDefinitionsWithHttpInfo	(	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)`
	)

inline

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

Returns: ApiResponse of PagedResourceListOfCutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ ListCutLabelDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCutLabelDefinition> > Lusid.Sdk.Api.CutLabelDefinitionsApi.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)`
	)

inline

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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ UpdateCutLabelDefinition()

CutLabelDefinition Lusid.Sdk.Api.CutLabelDefinitionsApi.UpdateCutLabelDefinition	(	string	code,
		UpdateCutLabelDefinitionRequest	updateCutLabelDefinitionRequest = `default(UpdateCutLabelDefinitionRequest)`
	)

inline

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

Returns: CutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ UpdateCutLabelDefinitionAsync()

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

inline

[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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ UpdateCutLabelDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CutLabelDefinition> Lusid.Sdk.Api.CutLabelDefinitionsApi.UpdateCutLabelDefinitionWithHttpInfo	(	string	code,
		UpdateCutLabelDefinitionRequest	updateCutLabelDefinitionRequest = `default(UpdateCutLabelDefinitionRequest)`
	)

inline

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

Returns: ApiResponse of CutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ UpdateCutLabelDefinitionWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.CutLabelDefinitionsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.CutLabelDefinitionsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.CutLabelDefinitionsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CutLabelDefinitionsApi() [1/4]

◆ CutLabelDefinitionsApi() [2/4]

◆ CutLabelDefinitionsApi() [3/4]

◆ CutLabelDefinitionsApi() [4/4]

Member Function Documentation

◆ CreateCutLabelDefinition()

◆ CreateCutLabelDefinitionAsync()

◆ CreateCutLabelDefinitionWithHttpInfo()

◆ CreateCutLabelDefinitionWithHttpInfoAsync()

◆ DeleteCutLabelDefinition()

◆ DeleteCutLabelDefinitionAsync()

◆ DeleteCutLabelDefinitionWithHttpInfo()

◆ DeleteCutLabelDefinitionWithHttpInfoAsync()

◆ GetBasePath()

◆ GetCutLabelDefinition()

◆ GetCutLabelDefinitionAsync()

◆ GetCutLabelDefinitionWithHttpInfo()

◆ GetCutLabelDefinitionWithHttpInfoAsync()

◆ ListCutLabelDefinitions()

◆ ListCutLabelDefinitionsAsync()

◆ ListCutLabelDefinitionsWithHttpInfo()

◆ ListCutLabelDefinitionsWithHttpInfoAsync()

◆ UpdateCutLabelDefinition()

◆ UpdateCutLabelDefinitionAsync()

◆ UpdateCutLabelDefinitionWithHttpInfo()

◆ UpdateCutLabelDefinitionWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory