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

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

Inheritance diagram for Lusid.Sdk.Api.AddressKeyDefinitionApi:
Inheritance graph
[legend]

Public Member Functions

 AddressKeyDefinitionApi ()
 Initializes a new instance of the AddressKeyDefinitionApi class. More...
 
 AddressKeyDefinitionApi (string basePath)
 Initializes a new instance of the AddressKeyDefinitionApi class. More...
 
 AddressKeyDefinitionApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the AddressKeyDefinitionApi class using Configuration object More...
 
 AddressKeyDefinitionApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the AddressKeyDefinitionApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
AddressKeyDefinition CreateAddressKeyDefinition (CreateAddressKeyDefinitionRequest createAddressKeyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. Create the given address key definition. More...
 
Lusid.Sdk.Client.ApiResponse< AddressKeyDefinitionCreateAddressKeyDefinitionWithHttpInfo (CreateAddressKeyDefinitionRequest createAddressKeyDefinitionRequest, int operationIndex=0)
 [EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. Create the given address key definition. More...
 
async System.Threading.Tasks.Task< AddressKeyDefinitionCreateAddressKeyDefinitionAsync (CreateAddressKeyDefinitionRequest createAddressKeyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. Create the given address key definition. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AddressKeyDefinition > > CreateAddressKeyDefinitionWithHttpInfoAsync (CreateAddressKeyDefinitionRequest createAddressKeyDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. Create the given address key definition. More...
 
AddressKeyDefinition GetAddressKeyDefinition (string key, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. Get the address key definition with the given address key at the specific asAt time. More...
 
Lusid.Sdk.Client.ApiResponse< AddressKeyDefinitionGetAddressKeyDefinitionWithHttpInfo (string key, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. Get the address key definition with the given address key at the specific asAt time. More...
 
async System.Threading.Tasks.Task< AddressKeyDefinitionGetAddressKeyDefinitionAsync (string key, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. Get the address key definition with the given address key at the specific asAt time. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AddressKeyDefinition > > GetAddressKeyDefinitionWithHttpInfoAsync (string key, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. Get the address key definition with the given address key at the specific asAt time. More...
 
PagedResourceListOfAddressKeyDefinition ListAddressKeyDefinitions (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. Fetch the last pre-AsAt date version of each address key definition. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAddressKeyDefinitionListAddressKeyDefinitionsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. Fetch the last pre-AsAt date version of each address key definition. More...
 
async System.Threading.Tasks.Task< PagedResourceListOfAddressKeyDefinitionListAddressKeyDefinitionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. Fetch the last pre-AsAt date version of each address key definition. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAddressKeyDefinition > > ListAddressKeyDefinitionsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. Fetch the last pre-AsAt date version of each address key definition. 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

◆ AddressKeyDefinitionApi() [1/4]

Lusid.Sdk.Api.AddressKeyDefinitionApi.AddressKeyDefinitionApi ( )
inline

Initializes a new instance of the AddressKeyDefinitionApi class.

Returns

◆ AddressKeyDefinitionApi() [2/4]

Lusid.Sdk.Api.AddressKeyDefinitionApi.AddressKeyDefinitionApi ( string  basePath)
inline

Initializes a new instance of the AddressKeyDefinitionApi class.

Returns

◆ AddressKeyDefinitionApi() [3/4]

Lusid.Sdk.Api.AddressKeyDefinitionApi.AddressKeyDefinitionApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the AddressKeyDefinitionApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ AddressKeyDefinitionApi() [4/4]

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

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

◆ CreateAddressKeyDefinition()

AddressKeyDefinition Lusid.Sdk.Api.AddressKeyDefinitionApi.CreateAddressKeyDefinition ( CreateAddressKeyDefinitionRequest  createAddressKeyDefinitionRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. Create the given address key definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createAddressKeyDefinitionRequestThe request used to create the address key definition.
operationIndexIndex associated with the operation.
Returns
AddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.

◆ CreateAddressKeyDefinitionAsync()

async System.Threading.Tasks.Task<AddressKeyDefinition> Lusid.Sdk.Api.AddressKeyDefinitionApi.CreateAddressKeyDefinitionAsync ( CreateAddressKeyDefinitionRequest  createAddressKeyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. Create the given address key definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createAddressKeyDefinitionRequestThe request used to create the address key definition.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiAsync.

◆ CreateAddressKeyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AddressKeyDefinition> Lusid.Sdk.Api.AddressKeyDefinitionApi.CreateAddressKeyDefinitionWithHttpInfo ( CreateAddressKeyDefinitionRequest  createAddressKeyDefinitionRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. Create the given address key definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createAddressKeyDefinitionRequestThe request used to create the address key definition.
operationIndexIndex associated with the operation.
Returns
ApiResponse of AddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.

◆ CreateAddressKeyDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AddressKeyDefinition> > Lusid.Sdk.Api.AddressKeyDefinitionApi.CreateAddressKeyDefinitionWithHttpInfoAsync ( CreateAddressKeyDefinitionRequest  createAddressKeyDefinitionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. Create the given address key definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createAddressKeyDefinitionRequestThe request used to create the address key definition.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AddressKeyDefinition)

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiAsync.

◆ GetAddressKeyDefinition()

AddressKeyDefinition Lusid.Sdk.Api.AddressKeyDefinitionApi.GetAddressKeyDefinition ( string  key,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. Get the address key definition with the given address key at the specific asAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
keyThe address key of the address key definition.
asAtThe asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
AddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.

◆ GetAddressKeyDefinitionAsync()

async System.Threading.Tasks.Task<AddressKeyDefinition> Lusid.Sdk.Api.AddressKeyDefinitionApi.GetAddressKeyDefinitionAsync ( string  key,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. Get the address key definition with the given address key at the specific asAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
keyThe address key of the address key definition.
asAtThe asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiAsync.

◆ GetAddressKeyDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AddressKeyDefinition> Lusid.Sdk.Api.AddressKeyDefinitionApi.GetAddressKeyDefinitionWithHttpInfo ( string  key,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. Get the address key definition with the given address key at the specific asAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
keyThe address key of the address key definition.
asAtThe asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of AddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.

◆ GetAddressKeyDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AddressKeyDefinition> > Lusid.Sdk.Api.AddressKeyDefinitionApi.GetAddressKeyDefinitionWithHttpInfoAsync ( string  key,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. Get the address key definition with the given address key at the specific asAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
keyThe address key of the address key definition.
asAtThe asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AddressKeyDefinition)

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.AddressKeyDefinitionApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ ListAddressKeyDefinitions()

PagedResourceListOfAddressKeyDefinition Lusid.Sdk.Api.AddressKeyDefinitionApi.ListAddressKeyDefinitions ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. Fetch the last pre-AsAt date version of each address key definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional)
pageThe pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfAddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.

◆ ListAddressKeyDefinitionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfAddressKeyDefinition> Lusid.Sdk.Api.AddressKeyDefinitionApi.ListAddressKeyDefinitionsAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. Fetch the last pre-AsAt date version of each address key definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional)
pageThe pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfAddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiAsync.

◆ ListAddressKeyDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAddressKeyDefinition> Lusid.Sdk.Api.AddressKeyDefinitionApi.ListAddressKeyDefinitionsWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. Fetch the last pre-AsAt date version of each address key definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional)
pageThe pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfAddressKeyDefinition

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.

◆ ListAddressKeyDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAddressKeyDefinition> > Lusid.Sdk.Api.AddressKeyDefinitionApi.ListAddressKeyDefinitionsWithHttpInfoAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. Fetch the last pre-AsAt date version of each address key definition.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional)
pageThe pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfAddressKeyDefinition)

Implements Lusid.Sdk.Api.IAddressKeyDefinitionApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.AddressKeyDefinitionApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.AddressKeyDefinitionApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.AddressKeyDefinitionApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.AddressKeyDefinitionApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


The documentation for this class was generated from the following file: