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

Inheritance diagram for Lusid.Sdk.Api.IAddressKeyAliasApiAsync:

[legend]

Public Member Functions
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. More...

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. More...

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 More...

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 More...

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 More...

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 More...

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. More...

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. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteAddressKeyAliasAsync()

System.Threading.Tasks.Task<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.IAddressKeyAliasApiAsync.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.

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

Implemented in Lusid.Sdk.Api.AddressKeyAliasApi.

◆ DeleteAddressKeyAliasWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AnnulSingleStructuredDataResponse> > Lusid.Sdk.Api.IAddressKeyAliasApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.AddressKeyAliasApi.

◆ GetAddressKeyAliasAsync()

System.Threading.Tasks.Task<GetAddressKeyAliasResponse> Lusid.Sdk.Api.IAddressKeyAliasApiAsync.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.

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

Implemented in Lusid.Sdk.Api.AddressKeyAliasApi.

◆ GetAddressKeyAliasWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<GetAddressKeyAliasResponse> > Lusid.Sdk.Api.IAddressKeyAliasApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.AddressKeyAliasApi.

◆ ListAddressKeyAliasesAsync()

System.Threading.Tasks.Task<PagedResourceListOfGetAddressKeyAliasResponse> Lusid.Sdk.Api.IAddressKeyAliasApiAsync.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.

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

Implemented in Lusid.Sdk.Api.AddressKeyAliasApi.

◆ ListAddressKeyAliasesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfGetAddressKeyAliasResponse> > Lusid.Sdk.Api.IAddressKeyAliasApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.AddressKeyAliasApi.

◆ UpsertAddressKeyAliasAsync()

System.Threading.Tasks.Task<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.IAddressKeyAliasApiAsync.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.

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

Implemented in Lusid.Sdk.Api.AddressKeyAliasApi.

◆ UpsertAddressKeyAliasWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertSingleStructuredDataResponse> > Lusid.Sdk.Api.IAddressKeyAliasApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.AddressKeyAliasApi.

The documentation for this interface 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

Detailed Description

Member Function Documentation

◆ DeleteAddressKeyAliasAsync()

◆ DeleteAddressKeyAliasWithHttpInfoAsync()

◆ GetAddressKeyAliasAsync()

◆ GetAddressKeyAliasWithHttpInfoAsync()

◆ ListAddressKeyAliasesAsync()

◆ ListAddressKeyAliasesWithHttpInfoAsync()

◆ UpsertAddressKeyAliasAsync()

◆ UpsertAddressKeyAliasWithHttpInfoAsync()