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

Inheritance diagram for Lusid.Sdk.Api.SettlementActivityApi:

[legend]

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

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

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

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

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

ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery	QuerySettlementActivity (SettlementActivityQuery settlementActivityQuery, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups. More...

Lusid.Sdk.Client.ApiResponse< ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery >	QuerySettlementActivityWithHttpInfo (SettlementActivityQuery settlementActivityQuery, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups. More...

async System.Threading.Tasks.Task< ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery >	QuerySettlementActivityAsync (SettlementActivityQuery settlementActivityQuery, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery > >	QuerySettlementActivityWithHttpInfoAsync (SettlementActivityQuery settlementActivityQuery, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups. 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

◆ SettlementActivityApi() [1/4]

Lusid.Sdk.Api.SettlementActivityApi.SettlementActivityApi ( )

inline

Initializes a new instance of the SettlementActivityApi class.

Returns

◆ SettlementActivityApi() [2/4]

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

inline

Initializes a new instance of the SettlementActivityApi class.

Returns

◆ SettlementActivityApi() [3/4]

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

inline

Initializes a new instance of the SettlementActivityApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ SettlementActivityApi() [4/4]

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

inline

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

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ QuerySettlementActivity()

ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery Lusid.Sdk.Api.SettlementActivityApi.QuerySettlementActivity	(	SettlementActivityQuery	settlementActivityQuery,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups.

Exceptions

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

Parameters

settlementActivityQuery	The query parameters controlling which settlement activity is returned.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery

Implements Lusid.Sdk.Api.ISettlementActivityApiSync.

◆ QuerySettlementActivityAsync()

async System.Threading.Tasks.Task<ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery> Lusid.Sdk.Api.SettlementActivityApi.QuerySettlementActivityAsync	(	SettlementActivityQuery	settlementActivityQuery,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups.

Exceptions

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

Parameters

settlementActivityQuery	The query parameters controlling which settlement activity is returned.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery

Implements Lusid.Sdk.Api.ISettlementActivityApiAsync.

◆ QuerySettlementActivityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery> Lusid.Sdk.Api.SettlementActivityApi.QuerySettlementActivityWithHttpInfo	(	SettlementActivityQuery	settlementActivityQuery,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups.

Exceptions

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

Parameters

settlementActivityQuery	The query parameters controlling which settlement activity is returned.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery

Implements Lusid.Sdk.Api.ISettlementActivityApiSync.

◆ QuerySettlementActivityWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery> > Lusid.Sdk.Api.SettlementActivityApi.QuerySettlementActivityWithHttpInfoAsync	(	SettlementActivityQuery	settlementActivityQuery,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups.

Exceptions

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

Parameters

settlementActivityQuery	The query parameters controlling which settlement activity is returned.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery)

Implements Lusid.Sdk.Api.ISettlementActivityApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.SettlementActivityApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.SettlementActivityApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.SettlementActivityApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SettlementActivityApi() [1/4]

◆ SettlementActivityApi() [2/4]

◆ SettlementActivityApi() [3/4]

◆ SettlementActivityApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ QuerySettlementActivity()

◆ QuerySettlementActivityAsync()

◆ QuerySettlementActivityWithHttpInfo()

◆ QuerySettlementActivityWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory