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

Inheritance diagram for Lusid.Sdk.Api.IReferencePortfolioApiAsync:

Public Member Functions
System.Threading.Tasks.Task< Portfolio >	CreateReferencePortfolioAsync (string scope, CreateReferencePortfolioRequest createReferencePortfolioRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Create reference portfolio More...

System.Threading.Tasks.Task< ApiResponse< Portfolio > >	CreateReferencePortfolioWithHttpInfoAsync (string scope, CreateReferencePortfolioRequest createReferencePortfolioRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Create reference portfolio More...

System.Threading.Tasks.Task< GetReferencePortfolioConstituentsResponse >	GetReferencePortfolioConstituentsAsync (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get reference portfolio constituents More...

System.Threading.Tasks.Task< ApiResponse< GetReferencePortfolioConstituentsResponse > >	GetReferencePortfolioConstituentsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get reference portfolio constituents More...

System.Threading.Tasks.Task< ResourceListOfConstituentsAdjustmentHeader >	ListConstituentsAdjustmentsAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAtTime=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	List constituents adjustments More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfConstituentsAdjustmentHeader > >	ListConstituentsAdjustmentsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAtTime=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	List constituents adjustments More...

System.Threading.Tasks.Task< UpsertReferencePortfolioConstituentsResponse >	UpsertReferencePortfolioConstituentsAsync (string scope, string code, UpsertReferencePortfolioConstituentsRequest upsertReferencePortfolioConstituentsRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert reference portfolio constituents More...

System.Threading.Tasks.Task< ApiResponse< UpsertReferencePortfolioConstituentsResponse > >	UpsertReferencePortfolioConstituentsWithHttpInfoAsync (string scope, string code, UpsertReferencePortfolioConstituentsRequest upsertReferencePortfolioConstituentsRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert reference portfolio constituents More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
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

Member Function Documentation

◆ CreateReferencePortfolioAsync()

System.Threading.Tasks.Task<Portfolio> Lusid.Sdk.Api.IReferencePortfolioApiAsync.CreateReferencePortfolioAsync	(	string	scope,
		CreateReferencePortfolioRequest	createReferencePortfolioRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Create reference portfolio

Create a reference portfolio in a particular scope.

Exceptions

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

Parameters

scope	The scope in which to create the reference portfolio.
createReferencePortfolioRequest	The definition of the reference portfolio.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Portfolio

Implemented in Lusid.Sdk.Api.ReferencePortfolioApi.

◆ CreateReferencePortfolioWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Portfolio> > Lusid.Sdk.Api.IReferencePortfolioApiAsync.CreateReferencePortfolioWithHttpInfoAsync	(	string	scope,
		CreateReferencePortfolioRequest	createReferencePortfolioRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Create reference portfolio

Create a reference portfolio in a particular scope.

Exceptions

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

Parameters

scope	The scope in which to create the reference portfolio.
createReferencePortfolioRequest	The definition of the reference portfolio.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Portfolio)

Implemented in Lusid.Sdk.Api.ReferencePortfolioApi.

◆ GetReferencePortfolioConstituentsAsync()

System.Threading.Tasks.Task<GetReferencePortfolioConstituentsResponse> Lusid.Sdk.Api.IReferencePortfolioApiAsync.GetReferencePortfolioConstituentsAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Get reference portfolio constituents

Get constituents from a reference portfolio at a particular effective time.

Exceptions

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

Parameters

scope	The scope of the reference portfolio.
code	The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
effectiveAt	The effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified. (optional)
propertyKeys	A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'ReferenceHolding/strategy/quantsignal'. Defaults to return all available instrument and reference holding properties if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of GetReferencePortfolioConstituentsResponse

Implemented in Lusid.Sdk.Api.ReferencePortfolioApi.

◆ GetReferencePortfolioConstituentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<GetReferencePortfolioConstituentsResponse> > Lusid.Sdk.Api.IReferencePortfolioApiAsync.GetReferencePortfolioConstituentsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Get reference portfolio constituents

Get constituents from a reference portfolio at a particular effective time.

Exceptions

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

Parameters

scope	The scope of the reference portfolio.
code	The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
effectiveAt	The effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified. (optional)
propertyKeys	A list of property keys from the 'Instrument' or 'ReferenceHolding' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'ReferenceHolding/strategy/quantsignal'. Defaults to return all available instrument and reference holding properties if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (GetReferencePortfolioConstituentsResponse)

Implemented in Lusid.Sdk.Api.ReferencePortfolioApi.

◆ ListConstituentsAdjustmentsAsync()

System.Threading.Tasks.Task<ResourceListOfConstituentsAdjustmentHeader> Lusid.Sdk.Api.IReferencePortfolioApiAsync.ListConstituentsAdjustmentsAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel	fromEffectiveAt,
		DateTimeOrCutLabel	toEffectiveAt,
		DateTimeOffset?	asAtTime = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

List constituents adjustments

List adjustments made to constituents in a reference portfolio.

Exceptions

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

Parameters

scope	The scope of the reference portfolio.
code	The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
fromEffectiveAt	Events between this time (inclusive) and the toEffectiveAt are returned.
toEffectiveAt	Events between this time (inclusive) and the fromEffectiveAt are returned.
asAtTime	The asAt time for which the result is valid. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfConstituentsAdjustmentHeader

Implemented in Lusid.Sdk.Api.ReferencePortfolioApi.

◆ ListConstituentsAdjustmentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfConstituentsAdjustmentHeader> > Lusid.Sdk.Api.IReferencePortfolioApiAsync.ListConstituentsAdjustmentsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel	fromEffectiveAt,
		DateTimeOrCutLabel	toEffectiveAt,
		DateTimeOffset?	asAtTime = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

List constituents adjustments

List adjustments made to constituents in a reference portfolio.

Exceptions

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

Parameters

scope	The scope of the reference portfolio.
code	The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
fromEffectiveAt	Events between this time (inclusive) and the toEffectiveAt are returned.
toEffectiveAt	Events between this time (inclusive) and the fromEffectiveAt are returned.
asAtTime	The asAt time for which the result is valid. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfConstituentsAdjustmentHeader)

Implemented in Lusid.Sdk.Api.ReferencePortfolioApi.

◆ UpsertReferencePortfolioConstituentsAsync()

System.Threading.Tasks.Task<UpsertReferencePortfolioConstituentsResponse> Lusid.Sdk.Api.IReferencePortfolioApiAsync.UpsertReferencePortfolioConstituentsAsync	(	string	scope,
		string	code,
		UpsertReferencePortfolioConstituentsRequest	upsertReferencePortfolioConstituentsRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Upsert reference portfolio constituents

Add constituents to a reference portfolio.

Exceptions

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

Parameters

scope	The scope of the reference portfolio.
code	The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentsRequest	The constituents to upload to the reference portfolio.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertReferencePortfolioConstituentsResponse

Implemented in Lusid.Sdk.Api.ReferencePortfolioApi.

◆ UpsertReferencePortfolioConstituentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertReferencePortfolioConstituentsResponse> > Lusid.Sdk.Api.IReferencePortfolioApiAsync.UpsertReferencePortfolioConstituentsWithHttpInfoAsync	(	string	scope,
		string	code,
		UpsertReferencePortfolioConstituentsRequest	upsertReferencePortfolioConstituentsRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

Upsert reference portfolio constituents

Add constituents to a reference portfolio.

Exceptions

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

Parameters

scope	The scope of the reference portfolio.
code	The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentsRequest	The constituents to upload to the reference portfolio.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertReferencePortfolioConstituentsResponse)

Implemented in Lusid.Sdk.Api.ReferencePortfolioApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/stable/sdk/Lusid.Sdk/Api/ReferencePortfolioApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateReferencePortfolioAsync()

◆ CreateReferencePortfolioWithHttpInfoAsync()

◆ GetReferencePortfolioConstituentsAsync()

◆ GetReferencePortfolioConstituentsWithHttpInfoAsync()

◆ ListConstituentsAdjustmentsAsync()

◆ ListConstituentsAdjustmentsWithHttpInfoAsync()

◆ UpsertReferencePortfolioConstituentsAsync()

◆ UpsertReferencePortfolioConstituentsWithHttpInfoAsync()