LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.CutLabelDefinitionsApi Class Reference

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

Inheritance diagram for Lusid.Sdk.Api.CutLabelDefinitionsApi:
Inheritance graph
[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?), int operationIndex=0)
 CreateCutLabelDefinition: Create a Cut Label Create a Cut Label valid in all scopes More...
 
Lusid.Sdk.Client.ApiResponse< CutLabelDefinitionCreateCutLabelDefinitionWithHttpInfo (CreateCutLabelDefinitionRequest? createCutLabelDefinitionRequest=default(CreateCutLabelDefinitionRequest?), int operationIndex=0)
 CreateCutLabelDefinition: Create a Cut Label Create a Cut Label valid in all scopes More...
 
async System.Threading.Tasks.Task< CutLabelDefinitionCreateCutLabelDefinitionAsync (CreateCutLabelDefinitionRequest? createCutLabelDefinitionRequest=default(CreateCutLabelDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreateCutLabelDefinition: 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?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreateCutLabelDefinition: Create a Cut Label Create a Cut Label valid in all scopes More...
 
DateTimeOffset DeleteCutLabelDefinition (string code, int operationIndex=0)
 DeleteCutLabelDefinition: Delete a Cut Label Delete a specified cut label More...
 
Lusid.Sdk.Client.ApiResponse< DateTimeOffset > DeleteCutLabelDefinitionWithHttpInfo (string code, int operationIndex=0)
 DeleteCutLabelDefinition: Delete a Cut Label Delete a specified cut label More...
 
async System.Threading.Tasks.Task< DateTimeOffset > DeleteCutLabelDefinitionAsync (string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeleteCutLabelDefinition: Delete a Cut Label Delete a specified cut label More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DateTimeOffset > > DeleteCutLabelDefinitionWithHttpInfoAsync (string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeleteCutLabelDefinition: Delete a Cut Label Delete a specified cut label More...
 
CutLabelDefinition GetCutLabelDefinition (string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetCutLabelDefinition: Get a Cut Label Get a specified cut label at a given time More...
 
Lusid.Sdk.Client.ApiResponse< CutLabelDefinitionGetCutLabelDefinitionWithHttpInfo (string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetCutLabelDefinition: Get a Cut Label Get a specified cut label at a given time More...
 
async System.Threading.Tasks.Task< CutLabelDefinitionGetCutLabelDefinitionAsync (string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetCutLabelDefinition: 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?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetCutLabelDefinition: 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? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0)
 ListCutLabelDefinitions: List Existing Cut Labels List all the Cut Label Definitions that are valid at the given AsAt time More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCutLabelDefinitionListCutLabelDefinitionsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0)
 ListCutLabelDefinitions: List Existing Cut Labels List all the Cut Label Definitions that are valid at the given AsAt time More...
 
async System.Threading.Tasks.Task< PagedResourceListOfCutLabelDefinitionListCutLabelDefinitionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListCutLabelDefinitions: 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? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListCutLabelDefinitions: 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?), int operationIndex=0)
 UpdateCutLabelDefinition: Update a Cut Label Update a specified cut label More...
 
Lusid.Sdk.Client.ApiResponse< CutLabelDefinitionUpdateCutLabelDefinitionWithHttpInfo (string code, UpdateCutLabelDefinitionRequest? updateCutLabelDefinitionRequest=default(UpdateCutLabelDefinitionRequest?), int operationIndex=0)
 UpdateCutLabelDefinition: Update a Cut Label Update a specified cut label More...
 
async System.Threading.Tasks.Task< CutLabelDefinitionUpdateCutLabelDefinitionAsync (string code, UpdateCutLabelDefinitionRequest? updateCutLabelDefinitionRequest=default(UpdateCutLabelDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpdateCutLabelDefinition: 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?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpdateCutLabelDefinition: 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
configurationAn 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
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ CreateCutLabelDefinition()

CutLabelDefinition Lusid.Sdk.Api.CutLabelDefinitionsApi.CreateCutLabelDefinition ( CreateCutLabelDefinitionRequest createCutLabelDefinitionRequest = default(CreateCutLabelDefinitionRequest?),
int  operationIndex = 0 
)
inline

CreateCutLabelDefinition: Create a Cut Label Create a Cut Label valid in all scopes

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCutLabelDefinitionRequestThe cut label definition (optional)
operationIndexIndex associated with the operation.
Returns
CutLabelDefinition

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ CreateCutLabelDefinitionAsync()

async System.Threading.Tasks.Task<CutLabelDefinition> Lusid.Sdk.Api.CutLabelDefinitionsApi.CreateCutLabelDefinitionAsync ( CreateCutLabelDefinitionRequest createCutLabelDefinitionRequest = default(CreateCutLabelDefinitionRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

CreateCutLabelDefinition: Create a Cut Label Create a Cut Label valid in all scopes

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCutLabelDefinitionRequestThe cut label definition (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?),
int  operationIndex = 0 
)
inline

CreateCutLabelDefinition: Create a Cut Label Create a Cut Label valid in all scopes

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCutLabelDefinitionRequestThe cut label definition (optional)
operationIndexIndex associated with the operation.
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?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

CreateCutLabelDefinition: Create a Cut Label Create a Cut Label valid in all scopes

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCutLabelDefinitionRequestThe cut label definition (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CutLabelDefinition)

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiAsync.

◆ DeleteCutLabelDefinition()

DateTimeOffset Lusid.Sdk.Api.CutLabelDefinitionsApi.DeleteCutLabelDefinition ( string  code,
int  operationIndex = 0 
)
inline

DeleteCutLabelDefinition: Delete a Cut Label Delete a specified cut label

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being Deleted
operationIndexIndex associated with the operation.
Returns
DateTimeOffset

Implements Lusid.Sdk.Api.ICutLabelDefinitionsApiSync.

◆ DeleteCutLabelDefinitionAsync()

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

DeleteCutLabelDefinition: Delete a Cut Label Delete a specified cut label

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being Deleted
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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,
int  operationIndex = 0 
)
inline

DeleteCutLabelDefinition: Delete a Cut Label Delete a specified cut label

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being Deleted
operationIndexIndex associated with the operation.
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,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

DeleteCutLabelDefinition: Delete a Cut Label Delete a specified cut label

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being Deleted
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?),
int  operationIndex = 0 
)
inline

GetCutLabelDefinition: Get a Cut Label Get a specified cut label at a given time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being queried
asAtThe time at which to get the Cut Label (optional)
operationIndexIndex associated with the operation.
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?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetCutLabelDefinition: Get a Cut Label Get a specified cut label at a given time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being queried
asAtThe time at which to get the Cut Label (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?),
int  operationIndex = 0 
)
inline

GetCutLabelDefinition: Get a Cut Label Get a specified cut label at a given time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being queried
asAtThe time at which to get the Cut Label (optional)
operationIndexIndex associated with the operation.
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?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetCutLabelDefinition: Get a Cut Label Get a specified cut label at a given time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being queried
asAtThe time at which to get the Cut Label (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?  limit = default(int?),
string?  filter = default(string?),
string?  page = default(string?),
int  operationIndex = 0 
)
inline

ListCutLabelDefinitions: List Existing Cut Labels List all the Cut Label Definitions that are valid at the given AsAt time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The As At time at which listed Cut Labels are valid (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. For example, to filter on code, use &quot;code eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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. (optional)
operationIndexIndex associated with the operation.
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?  limit = default(int?),
string?  filter = default(string?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

ListCutLabelDefinitions: List Existing Cut Labels List all the Cut Label Definitions that are valid at the given AsAt time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The As At time at which listed Cut Labels are valid (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. For example, to filter on code, use &quot;code eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?  limit = default(int?),
string?  filter = default(string?),
string?  page = default(string?),
int  operationIndex = 0 
)
inline

ListCutLabelDefinitions: List Existing Cut Labels List all the Cut Label Definitions that are valid at the given AsAt time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The As At time at which listed Cut Labels are valid (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. For example, to filter on code, use &quot;code eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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. (optional)
operationIndexIndex associated with the operation.
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?  limit = default(int?),
string?  filter = default(string?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

ListCutLabelDefinitions: List Existing Cut Labels List all the Cut Label Definitions that are valid at the given AsAt time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The As At time at which listed Cut Labels are valid (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. For example, to filter on code, use &quot;code eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?),
int  operationIndex = 0 
)
inline

UpdateCutLabelDefinition: Update a Cut Label Update a specified cut label

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being updated
updateCutLabelDefinitionRequestThe cut label update definition (optional)
operationIndexIndex associated with the operation.
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?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

UpdateCutLabelDefinition: Update a Cut Label Update a specified cut label

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being updated
updateCutLabelDefinitionRequestThe cut label update definition (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?),
int  operationIndex = 0 
)
inline

UpdateCutLabelDefinition: Update a Cut Label Update a specified cut label

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being updated
updateCutLabelDefinitionRequestThe cut label update definition (optional)
operationIndexIndex associated with the operation.
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?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

UpdateCutLabelDefinition: Update a Cut Label Update a specified cut label

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
codeThe Code of the Cut Label that is being updated
updateCutLabelDefinitionRequestThe cut label update definition (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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: