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

Inheritance diagram for Lusid.Sdk.Api.AddressKeyAliasApi:

[legend]

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

	AddressKeyAliasApi (string basePath)
	Initializes a new instance of the AddressKeyAliasApi class. More...

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

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

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

AnnulSingleStructuredDataResponse	DeleteAddressKeyAlias (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. More...

Lusid.Sdk.Client.ApiResponse< AnnulSingleStructuredDataResponse >	DeleteAddressKeyAliasWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. More...

async System.Threading.Tasks.Task< AnnulSingleStructuredDataResponse >	DeleteAddressKeyAliasAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AnnulSingleStructuredDataResponse > >	DeleteAddressKeyAliasWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. More...

GetAddressKeyAliasResponse	GetAddressKeyAlias (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful. More...

Lusid.Sdk.Client.ApiResponse< GetAddressKeyAliasResponse >	GetAddressKeyAliasWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful. More...

async System.Threading.Tasks.Task< GetAddressKeyAliasResponse >	GetAddressKeyAliasAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< GetAddressKeyAliasResponse > >	GetAddressKeyAliasWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful. More...

PagedResourceListOfGetAddressKeyAliasResponse	ListAddressKeyAliases (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases List the set of address key aliases at the specified date/time and scope. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfGetAddressKeyAliasResponse >	ListAddressKeyAliasesWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases List the set of address key aliases at the specified date/time and scope. More...

async System.Threading.Tasks.Task< PagedResourceListOfGetAddressKeyAliasResponse >	ListAddressKeyAliasesAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases List the set of address key aliases at the specified date/time and scope. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfGetAddressKeyAliasResponse > >	ListAddressKeyAliasesWithHttpInfoAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases List the set of address key aliases at the specified date/time and scope. More...

UpsertSingleStructuredDataResponse	UpsertAddressKeyAlias (UpsertAddressKeyAliasRequest upsertAddressKeyAliasRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful. More...

Lusid.Sdk.Client.ApiResponse< UpsertSingleStructuredDataResponse >	UpsertAddressKeyAliasWithHttpInfo (UpsertAddressKeyAliasRequest upsertAddressKeyAliasRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful. More...

async System.Threading.Tasks.Task< UpsertSingleStructuredDataResponse >	UpsertAddressKeyAliasAsync (UpsertAddressKeyAliasRequest upsertAddressKeyAliasRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertSingleStructuredDataResponse > >	UpsertAddressKeyAliasWithHttpInfoAsync (UpsertAddressKeyAliasRequest upsertAddressKeyAliasRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful. 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...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ AddressKeyAliasApi() [1/4]

Lusid.Sdk.Api.AddressKeyAliasApi.AddressKeyAliasApi ( )

inline

Initializes a new instance of the AddressKeyAliasApi class.

Returns

◆ AddressKeyAliasApi() [2/4]

Lusid.Sdk.Api.AddressKeyAliasApi.AddressKeyAliasApi ( string basePath )

inline

Initializes a new instance of the AddressKeyAliasApi class.

Returns

◆ AddressKeyAliasApi() [3/4]

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

inline

Initializes a new instance of the AddressKeyAliasApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ AddressKeyAliasApi() [4/4]

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

inline

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

◆ DeleteAddressKeyAlias()

AnnulSingleStructuredDataResponse Lusid.Sdk.Api.AddressKeyAliasApi.DeleteAddressKeyAlias	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed.

Exceptions

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

Parameters

scope	The scope of the Address Key Alias to delete.
code	The Address Key Alias to delete.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: AnnulSingleStructuredDataResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiSync.

◆ DeleteAddressKeyAliasAsync()

async System.Threading.Tasks.Task<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.AddressKeyAliasApi.DeleteAddressKeyAliasAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed.

Exceptions

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

Parameters

scope	The scope of the Address Key Alias to delete.
code	The Address Key Alias to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of AnnulSingleStructuredDataResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiAsync.

◆ DeleteAddressKeyAliasWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.AddressKeyAliasApi.DeleteAddressKeyAliasWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed.

Exceptions

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

Parameters

scope	The scope of the Address Key Alias to delete.
code	The Address Key Alias to delete.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of AnnulSingleStructuredDataResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiSync.

◆ DeleteAddressKeyAliasWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AnnulSingleStructuredDataResponse> > Lusid.Sdk.Api.AddressKeyAliasApi.DeleteAddressKeyAliasWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed.

Exceptions

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

Parameters

scope	The scope of the Address Key Alias to delete.
code	The Address Key Alias to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (AnnulSingleStructuredDataResponse)

Implements Lusid.Sdk.Api.IAddressKeyAliasApiAsync.

◆ GetAddressKeyAlias()

GetAddressKeyAliasResponse Lusid.Sdk.Api.AddressKeyAliasApi.GetAddressKeyAlias	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful.

Exceptions

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

Parameters

scope	The scope of the Address Key Alias to retrieve.
code	The code of the alias to retrieve.
asAt	The asAt datetime at which to retrieve the alias. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: GetAddressKeyAliasResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiSync.

◆ GetAddressKeyAliasAsync()

async System.Threading.Tasks.Task<GetAddressKeyAliasResponse> Lusid.Sdk.Api.AddressKeyAliasApi.GetAddressKeyAliasAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful.

Exceptions

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

Parameters

scope	The scope of the Address Key Alias to retrieve.
code	The code of the alias to retrieve.
asAt	The asAt datetime at which to retrieve the alias. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of GetAddressKeyAliasResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiAsync.

◆ GetAddressKeyAliasWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GetAddressKeyAliasResponse> Lusid.Sdk.Api.AddressKeyAliasApi.GetAddressKeyAliasWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful.

Exceptions

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

Parameters

scope	The scope of the Address Key Alias to retrieve.
code	The code of the alias to retrieve.
asAt	The asAt datetime at which to retrieve the alias. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of GetAddressKeyAliasResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiSync.

◆ GetAddressKeyAliasWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<GetAddressKeyAliasResponse> > Lusid.Sdk.Api.AddressKeyAliasApi.GetAddressKeyAliasWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful.

Exceptions

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

Parameters

scope	The scope of the Address Key Alias to retrieve.
code	The code of the alias to retrieve.
asAt	The asAt datetime at which to retrieve the alias. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (GetAddressKeyAliasResponse)

Implements Lusid.Sdk.Api.IAddressKeyAliasApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.AddressKeyAliasApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

◆ ListAddressKeyAliases()

PagedResourceListOfGetAddressKeyAliasResponse Lusid.Sdk.Api.AddressKeyAliasApi.ListAddressKeyAliases	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases List the set of address key aliases at the specified date/time and scope.

Exceptions

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

Parameters

scope	The scope to list aliases for.
asAt	The asAt datetime at which to list the aliases. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set. (optional)
limit	Maximum number of results to return. Defaults to 100. (optional)
page	Pagination token from a previous result to fetch the next page. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfGetAddressKeyAliasResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiSync.

◆ ListAddressKeyAliasesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfGetAddressKeyAliasResponse> Lusid.Sdk.Api.AddressKeyAliasApi.ListAddressKeyAliasesAsync	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases List the set of address key aliases at the specified date/time and scope.

Exceptions

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

Parameters

scope	The scope to list aliases for.
asAt	The asAt datetime at which to list the aliases. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set. (optional)
limit	Maximum number of results to return. Defaults to 100. (optional)
page	Pagination token from a previous result to fetch the next page. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfGetAddressKeyAliasResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiAsync.

◆ ListAddressKeyAliasesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfGetAddressKeyAliasResponse> Lusid.Sdk.Api.AddressKeyAliasApi.ListAddressKeyAliasesWithHttpInfo	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases List the set of address key aliases at the specified date/time and scope.

Exceptions

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

Parameters

scope	The scope to list aliases for.
asAt	The asAt datetime at which to list the aliases. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set. (optional)
limit	Maximum number of results to return. Defaults to 100. (optional)
page	Pagination token from a previous result to fetch the next page. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfGetAddressKeyAliasResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiSync.

◆ ListAddressKeyAliasesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfGetAddressKeyAliasResponse> > Lusid.Sdk.Api.AddressKeyAliasApi.ListAddressKeyAliasesWithHttpInfoAsync	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases List the set of address key aliases at the specified date/time and scope.

Exceptions

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

Parameters

scope	The scope to list aliases for.
asAt	The asAt datetime at which to list the aliases. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set. (optional)
limit	Maximum number of results to return. Defaults to 100. (optional)
page	Pagination token from a previous result to fetch the next page. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfGetAddressKeyAliasResponse)

Implements Lusid.Sdk.Api.IAddressKeyAliasApiAsync.

◆ UpsertAddressKeyAlias()

UpsertSingleStructuredDataResponse Lusid.Sdk.Api.AddressKeyAliasApi.UpsertAddressKeyAlias	(	UpsertAddressKeyAliasRequest	upsertAddressKeyAliasRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful.

Exceptions

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

Parameters

upsertAddressKeyAliasRequest	The Address Key Alias to update or insert
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: UpsertSingleStructuredDataResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiSync.

◆ UpsertAddressKeyAliasAsync()

async System.Threading.Tasks.Task<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.AddressKeyAliasApi.UpsertAddressKeyAliasAsync	(	UpsertAddressKeyAliasRequest	upsertAddressKeyAliasRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful.

Exceptions

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

Parameters

upsertAddressKeyAliasRequest	The Address Key Alias to update or insert
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of UpsertSingleStructuredDataResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiAsync.

◆ UpsertAddressKeyAliasWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.AddressKeyAliasApi.UpsertAddressKeyAliasWithHttpInfo	(	UpsertAddressKeyAliasRequest	upsertAddressKeyAliasRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful.

Exceptions

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

Parameters

upsertAddressKeyAliasRequest	The Address Key Alias to update or insert
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of UpsertSingleStructuredDataResponse

Implements Lusid.Sdk.Api.IAddressKeyAliasApiSync.

◆ UpsertAddressKeyAliasWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertSingleStructuredDataResponse> > Lusid.Sdk.Api.AddressKeyAliasApi.UpsertAddressKeyAliasWithHttpInfoAsync	(	UpsertAddressKeyAliasRequest	upsertAddressKeyAliasRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful.

Exceptions

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

Parameters

upsertAddressKeyAliasRequest	The Address Key Alias to update or insert
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (UpsertSingleStructuredDataResponse)

Implements Lusid.Sdk.Api.IAddressKeyAliasApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.AddressKeyAliasApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.AddressKeyAliasApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.AddressKeyAliasApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AddressKeyAliasApi() [1/4]

◆ AddressKeyAliasApi() [2/4]

◆ AddressKeyAliasApi() [3/4]

◆ AddressKeyAliasApi() [4/4]

Member Function Documentation

◆ DeleteAddressKeyAlias()

◆ DeleteAddressKeyAliasAsync()

◆ DeleteAddressKeyAliasWithHttpInfo()

◆ DeleteAddressKeyAliasWithHttpInfoAsync()

◆ GetAddressKeyAlias()

◆ GetAddressKeyAliasAsync()

◆ GetAddressKeyAliasWithHttpInfo()

◆ GetAddressKeyAliasWithHttpInfoAsync()

◆ GetBasePath()

◆ ListAddressKeyAliases()

◆ ListAddressKeyAliasesAsync()

◆ ListAddressKeyAliasesWithHttpInfo()

◆ ListAddressKeyAliasesWithHttpInfoAsync()

◆ UpsertAddressKeyAlias()

◆ UpsertAddressKeyAliasAsync()

◆ UpsertAddressKeyAliasWithHttpInfo()

◆ UpsertAddressKeyAliasWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory