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

Inheritance diagram for Lusid.Sdk.Api.DerivedTransactionPortfoliosApi:

[legend]

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

	DerivedTransactionPortfoliosApi (String basePath)
	Initializes a new instance of the DerivedTransactionPortfoliosApi class. More...

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

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

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

Portfolio	CreateDerivedPortfolio (string scope, CreateDerivedTransactionPortfolioRequest createDerivedTransactionPortfolioRequest=default(CreateDerivedTransactionPortfolioRequest))
	[EARLY ACCESS] Create derived portfolio Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived). More...

Lusid.Sdk.Client.ApiResponse< Portfolio >	CreateDerivedPortfolioWithHttpInfo (string scope, CreateDerivedTransactionPortfolioRequest createDerivedTransactionPortfolioRequest=default(CreateDerivedTransactionPortfolioRequest))
	[EARLY ACCESS] Create derived portfolio Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived). More...

async System.Threading.Tasks.Task< Portfolio >	CreateDerivedPortfolioAsync (string scope, CreateDerivedTransactionPortfolioRequest createDerivedTransactionPortfolioRequest=default(CreateDerivedTransactionPortfolioRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create derived portfolio Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived). More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Portfolio > >	CreateDerivedPortfolioWithHttpInfoAsync (string scope, CreateDerivedTransactionPortfolioRequest createDerivedTransactionPortfolioRequest=default(CreateDerivedTransactionPortfolioRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create derived portfolio Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived). More...

DeletedEntityResponse	DeleteDerivedPortfolioDetails (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
	[EARLY ACCESS] Delete derived portfolio details Delete all the portfolio details for a derived transaction portfolio. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteDerivedPortfolioDetailsWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
	[EARLY ACCESS] Delete derived portfolio details Delete all the portfolio details for a derived transaction portfolio. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteDerivedPortfolioDetailsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete derived portfolio details Delete all the portfolio details for a derived transaction portfolio. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteDerivedPortfolioDetailsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete derived portfolio details Delete all the portfolio details for a derived transaction portfolio. 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

◆ DerivedTransactionPortfoliosApi() [1/4]

Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.DerivedTransactionPortfoliosApi ( )

inline

Initializes a new instance of the DerivedTransactionPortfoliosApi class.

Returns

◆ DerivedTransactionPortfoliosApi() [2/4]

Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.DerivedTransactionPortfoliosApi ( String basePath )

inline

Initializes a new instance of the DerivedTransactionPortfoliosApi class.

Returns

◆ DerivedTransactionPortfoliosApi() [3/4]

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

inline

Initializes a new instance of the DerivedTransactionPortfoliosApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ DerivedTransactionPortfoliosApi() [4/4]

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

inline

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

◆ CreateDerivedPortfolio()

Portfolio Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.CreateDerivedPortfolio	(	string	scope,
		CreateDerivedTransactionPortfolioRequest	createDerivedTransactionPortfolioRequest = `default(CreateDerivedTransactionPortfolioRequest)`
	)

inline

[EARLY ACCESS] Create derived portfolio Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived).

Exceptions

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

Parameters

scope	The scope in which to create the derived transaction portfolio.
createDerivedTransactionPortfolioRequest	The definition of the derived transaction portfolio. (optional)

Returns: Portfolio

Implements Lusid.Sdk.Api.IDerivedTransactionPortfoliosApiSync.

◆ CreateDerivedPortfolioAsync()

async System.Threading.Tasks.Task<Portfolio> Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.CreateDerivedPortfolioAsync	(	string	scope,
		CreateDerivedTransactionPortfolioRequest	createDerivedTransactionPortfolioRequest = `default(CreateDerivedTransactionPortfolioRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Create derived portfolio Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived).

Exceptions

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

Parameters

scope	The scope in which to create the derived transaction portfolio.
createDerivedTransactionPortfolioRequest	The definition of the derived transaction portfolio. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Portfolio

Implements Lusid.Sdk.Api.IDerivedTransactionPortfoliosApiAsync.

◆ CreateDerivedPortfolioWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Portfolio> Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.CreateDerivedPortfolioWithHttpInfo	(	string	scope,
		CreateDerivedTransactionPortfolioRequest	createDerivedTransactionPortfolioRequest = `default(CreateDerivedTransactionPortfolioRequest)`
	)

inline

[EARLY ACCESS] Create derived portfolio Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived).

Exceptions

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

Parameters

scope	The scope in which to create the derived transaction portfolio.
createDerivedTransactionPortfolioRequest	The definition of the derived transaction portfolio. (optional)

Returns: ApiResponse of Portfolio

Implements Lusid.Sdk.Api.IDerivedTransactionPortfoliosApiSync.

◆ CreateDerivedPortfolioWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Portfolio> > Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.CreateDerivedPortfolioWithHttpInfoAsync	(	string	scope,
		CreateDerivedTransactionPortfolioRequest	createDerivedTransactionPortfolioRequest = `default(CreateDerivedTransactionPortfolioRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Create derived portfolio Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived).

Exceptions

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

Parameters

scope	The scope in which to create the derived transaction portfolio.
createDerivedTransactionPortfolioRequest	The definition of the derived transaction portfolio. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Portfolio)

Implements Lusid.Sdk.Api.IDerivedTransactionPortfoliosApiAsync.

◆ DeleteDerivedPortfolioDetails()

DeletedEntityResponse Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.DeleteDerivedPortfolioDetails	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`
	)

inline

[EARLY ACCESS] Delete derived portfolio details Delete all the portfolio details for a derived transaction portfolio.

Exceptions

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

Parameters

scope	The scope of the derived transaction portfolio.
code	The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio.
effectiveAt	The effective date of the change. (optional)

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IDerivedTransactionPortfoliosApiSync.

◆ DeleteDerivedPortfolioDetailsAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.DeleteDerivedPortfolioDetailsAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Delete derived portfolio details Delete all the portfolio details for a derived transaction portfolio.

Exceptions

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

Parameters

scope	The scope of the derived transaction portfolio.
code	The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio.
effectiveAt	The effective date of the change. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IDerivedTransactionPortfoliosApiAsync.

◆ DeleteDerivedPortfolioDetailsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.DeleteDerivedPortfolioDetailsWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`
	)

inline

[EARLY ACCESS] Delete derived portfolio details Delete all the portfolio details for a derived transaction portfolio.

Exceptions

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

Parameters

scope	The scope of the derived transaction portfolio.
code	The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio.
effectiveAt	The effective date of the change. (optional)

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IDerivedTransactionPortfoliosApiSync.

◆ DeleteDerivedPortfolioDetailsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.DeleteDerivedPortfolioDetailsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Delete derived portfolio details Delete all the portfolio details for a derived transaction portfolio.

Exceptions

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

Parameters

scope	The scope of the derived transaction portfolio.
code	The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio.
effectiveAt	The effective date of the change. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IDerivedTransactionPortfoliosApiAsync.

◆ GetBasePath()

String Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.DerivedTransactionPortfoliosApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DerivedTransactionPortfoliosApi() [1/4]

◆ DerivedTransactionPortfoliosApi() [2/4]

◆ DerivedTransactionPortfoliosApi() [3/4]

◆ DerivedTransactionPortfoliosApi() [4/4]

Member Function Documentation

◆ CreateDerivedPortfolio()

◆ CreateDerivedPortfolioAsync()

◆ CreateDerivedPortfolioWithHttpInfo()

◆ CreateDerivedPortfolioWithHttpInfoAsync()

◆ DeleteDerivedPortfolioDetails()

◆ DeleteDerivedPortfolioDetailsAsync()

◆ DeleteDerivedPortfolioDetailsWithHttpInfo()

◆ DeleteDerivedPortfolioDetailsWithHttpInfoAsync()

◆ GetBasePath()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory