LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.ReferencePortfolioApi Class Reference

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

Inheritance diagram for Lusid.Sdk.Api.ReferencePortfolioApi:
Inheritance graph
[legend]

Public Member Functions

 ReferencePortfolioApi ()
 Initializes a new instance of the ReferencePortfolioApi class. More...
 
 ReferencePortfolioApi (string basePath)
 Initializes a new instance of the ReferencePortfolioApi class. More...
 
 ReferencePortfolioApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the ReferencePortfolioApi class using Configuration object More...
 
 ReferencePortfolioApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the ReferencePortfolioApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
Portfolio CreateReferencePortfolio (string scope, CreateReferencePortfolioRequest createReferencePortfolioRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 CreateReferencePortfolio: Create reference portfolio Create a reference portfolio in a particular scope. More...
 
Lusid.Sdk.Client.ApiResponse< PortfolioCreateReferencePortfolioWithHttpInfo (string scope, CreateReferencePortfolioRequest createReferencePortfolioRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 CreateReferencePortfolio: Create reference portfolio Create a reference portfolio in a particular scope. More...
 
async System.Threading.Tasks.Task< PortfolioCreateReferencePortfolioAsync (string scope, CreateReferencePortfolioRequest createReferencePortfolioRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 CreateReferencePortfolio: Create reference portfolio Create a reference portfolio in a particular scope. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Portfolio > > CreateReferencePortfolioWithHttpInfoAsync (string scope, CreateReferencePortfolioRequest createReferencePortfolioRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 CreateReferencePortfolio: Create reference portfolio Create a reference portfolio in a particular scope. More...
 
GetReferencePortfolioConstituentsResponse GetReferencePortfolioConstituents (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 GetReferencePortfolioConstituents: Get reference portfolio constituents Get constituents from a reference portfolio at a particular effective time. More...
 
Lusid.Sdk.Client.ApiResponse< GetReferencePortfolioConstituentsResponseGetReferencePortfolioConstituentsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 GetReferencePortfolioConstituents: Get reference portfolio constituents Get constituents from a reference portfolio at a particular effective time. More...
 
async System.Threading.Tasks.Task< GetReferencePortfolioConstituentsResponseGetReferencePortfolioConstituentsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 GetReferencePortfolioConstituents: Get reference portfolio constituents Get constituents from a reference portfolio at a particular effective time. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< GetReferencePortfolioConstituentsResponse > > GetReferencePortfolioConstituentsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 GetReferencePortfolioConstituents: Get reference portfolio constituents Get constituents from a reference portfolio at a particular effective time. More...
 
ResourceListOfConstituentsAdjustmentHeader ListConstituentsAdjustments (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAtTime=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 ListConstituentsAdjustments: List constituents adjustments List adjustments made to constituents in a reference portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfConstituentsAdjustmentHeaderListConstituentsAdjustmentsWithHttpInfo (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAtTime=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 ListConstituentsAdjustments: List constituents adjustments List adjustments made to constituents in a reference portfolio. More...
 
async System.Threading.Tasks.Task< ResourceListOfConstituentsAdjustmentHeaderListConstituentsAdjustmentsAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAtTime=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 ListConstituentsAdjustments: List constituents adjustments List adjustments made to constituents in a reference portfolio. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfConstituentsAdjustmentHeader > > ListConstituentsAdjustmentsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAtTime=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 ListConstituentsAdjustments: List constituents adjustments List adjustments made to constituents in a reference portfolio. More...
 
UpsertReferencePortfolioConstituentPropertiesResponse UpsertReferencePortfolioConstituentProperties (string scope, string code, UpsertReferencePortfolioConstituentPropertiesRequest upsertReferencePortfolioConstituentPropertiesRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated. More...
 
Lusid.Sdk.Client.ApiResponse< UpsertReferencePortfolioConstituentPropertiesResponseUpsertReferencePortfolioConstituentPropertiesWithHttpInfo (string scope, string code, UpsertReferencePortfolioConstituentPropertiesRequest upsertReferencePortfolioConstituentPropertiesRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated. More...
 
async System.Threading.Tasks.Task< UpsertReferencePortfolioConstituentPropertiesResponseUpsertReferencePortfolioConstituentPropertiesAsync (string scope, string code, UpsertReferencePortfolioConstituentPropertiesRequest upsertReferencePortfolioConstituentPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertReferencePortfolioConstituentPropertiesResponse > > UpsertReferencePortfolioConstituentPropertiesWithHttpInfoAsync (string scope, string code, UpsertReferencePortfolioConstituentPropertiesRequest upsertReferencePortfolioConstituentPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated. More...
 
UpsertReferencePortfolioConstituentsResponse UpsertReferencePortfolioConstituents (string scope, string code, UpsertReferencePortfolioConstituentsRequest upsertReferencePortfolioConstituentsRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents Add constituents to a reference portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< UpsertReferencePortfolioConstituentsResponseUpsertReferencePortfolioConstituentsWithHttpInfo (string scope, string code, UpsertReferencePortfolioConstituentsRequest upsertReferencePortfolioConstituentsRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents Add constituents to a reference portfolio. More...
 
async System.Threading.Tasks.Task< UpsertReferencePortfolioConstituentsResponseUpsertReferencePortfolioConstituentsAsync (string scope, string code, UpsertReferencePortfolioConstituentsRequest upsertReferencePortfolioConstituentsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents Add constituents to a reference portfolio. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertReferencePortfolioConstituentsResponse > > UpsertReferencePortfolioConstituentsWithHttpInfoAsync (string scope, string code, UpsertReferencePortfolioConstituentsRequest upsertReferencePortfolioConstituentsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents Add constituents to a reference 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...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ ReferencePortfolioApi() [1/4]

Lusid.Sdk.Api.ReferencePortfolioApi.ReferencePortfolioApi ( )
inline

Initializes a new instance of the ReferencePortfolioApi class.

Returns

◆ ReferencePortfolioApi() [2/4]

Lusid.Sdk.Api.ReferencePortfolioApi.ReferencePortfolioApi ( string  basePath)
inline

Initializes a new instance of the ReferencePortfolioApi class.

Returns

◆ ReferencePortfolioApi() [3/4]

Lusid.Sdk.Api.ReferencePortfolioApi.ReferencePortfolioApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the ReferencePortfolioApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ ReferencePortfolioApi() [4/4]

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

Initializes a new instance of the ReferencePortfolioApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ CreateReferencePortfolio()

Portfolio Lusid.Sdk.Api.ReferencePortfolioApi.CreateReferencePortfolio ( string  scope,
CreateReferencePortfolioRequest  createReferencePortfolioRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

CreateReferencePortfolio: Create reference portfolio Create a reference portfolio in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create the reference portfolio.
createReferencePortfolioRequestThe definition of the reference portfolio.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
Portfolio

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ CreateReferencePortfolioAsync()

async System.Threading.Tasks.Task<Portfolio> Lusid.Sdk.Api.ReferencePortfolioApi.CreateReferencePortfolioAsync ( string  scope,
CreateReferencePortfolioRequest  createReferencePortfolioRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

CreateReferencePortfolio: Create reference portfolio Create a reference portfolio in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create the reference portfolio.
createReferencePortfolioRequestThe definition of the reference portfolio.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of Portfolio

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ CreateReferencePortfolioWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Portfolio> Lusid.Sdk.Api.ReferencePortfolioApi.CreateReferencePortfolioWithHttpInfo ( string  scope,
CreateReferencePortfolioRequest  createReferencePortfolioRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

CreateReferencePortfolio: Create reference portfolio Create a reference portfolio in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create the reference portfolio.
createReferencePortfolioRequestThe definition of the reference portfolio.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of Portfolio

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ CreateReferencePortfolioWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Portfolio> > Lusid.Sdk.Api.ReferencePortfolioApi.CreateReferencePortfolioWithHttpInfoAsync ( string  scope,
CreateReferencePortfolioRequest  createReferencePortfolioRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

CreateReferencePortfolio: Create reference portfolio Create a reference portfolio in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create the reference portfolio.
createReferencePortfolioRequestThe definition of the reference portfolio.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (Portfolio)

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.ReferencePortfolioApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

◆ GetReferencePortfolioConstituents()

GetReferencePortfolioConstituentsResponse Lusid.Sdk.Api.ReferencePortfolioApi.GetReferencePortfolioConstituents ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List<string>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
effectiveAtThe effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified. (optional)
propertyKeysA list of property keys from the &#39;Instrument&#39; or &#39;ReferenceHolding&#39; domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. &#39;Instrument/system/Name&#39; or &#39;ReferenceHolding/strategy/quantsignal&#39;. Defaults to return all available instrument and reference holding properties if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
GetReferencePortfolioConstituentsResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ GetReferencePortfolioConstituentsAsync()

async System.Threading.Tasks.Task<GetReferencePortfolioConstituentsResponse> Lusid.Sdk.Api.ReferencePortfolioApi.GetReferencePortfolioConstituentsAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
effectiveAtThe effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified. (optional)
propertyKeysA list of property keys from the &#39;Instrument&#39; or &#39;ReferenceHolding&#39; domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. &#39;Instrument/system/Name&#39; or &#39;ReferenceHolding/strategy/quantsignal&#39;. Defaults to return all available instrument and reference holding properties if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of GetReferencePortfolioConstituentsResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ GetReferencePortfolioConstituentsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GetReferencePortfolioConstituentsResponse> Lusid.Sdk.Api.ReferencePortfolioApi.GetReferencePortfolioConstituentsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List<string>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
effectiveAtThe effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified. (optional)
propertyKeysA list of property keys from the &#39;Instrument&#39; or &#39;ReferenceHolding&#39; domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. &#39;Instrument/system/Name&#39; or &#39;ReferenceHolding/strategy/quantsignal&#39;. Defaults to return all available instrument and reference holding properties if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of GetReferencePortfolioConstituentsResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ GetReferencePortfolioConstituentsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<GetReferencePortfolioConstituentsResponse> > Lusid.Sdk.Api.ReferencePortfolioApi.GetReferencePortfolioConstituentsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
effectiveAtThe effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified. (optional)
propertyKeysA list of property keys from the &#39;Instrument&#39; or &#39;ReferenceHolding&#39; domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. &#39;Instrument/system/Name&#39; or &#39;ReferenceHolding/strategy/quantsignal&#39;. Defaults to return all available instrument and reference holding properties if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (GetReferencePortfolioConstituentsResponse)

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ ListConstituentsAdjustments()

ResourceListOfConstituentsAdjustmentHeader Lusid.Sdk.Api.ReferencePortfolioApi.ListConstituentsAdjustments ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAtTime = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

ListConstituentsAdjustments: List constituents adjustments List adjustments made to constituents in a reference portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
fromEffectiveAtEvents between this time (inclusive) and the toEffectiveAt are returned.
toEffectiveAtEvents between this time (inclusive) and the fromEffectiveAt are returned.
asAtTimeThe asAt time for which the result is valid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfConstituentsAdjustmentHeader

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ ListConstituentsAdjustmentsAsync()

async System.Threading.Tasks.Task<ResourceListOfConstituentsAdjustmentHeader> Lusid.Sdk.Api.ReferencePortfolioApi.ListConstituentsAdjustmentsAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAtTime = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

ListConstituentsAdjustments: List constituents adjustments List adjustments made to constituents in a reference portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
fromEffectiveAtEvents between this time (inclusive) and the toEffectiveAt are returned.
toEffectiveAtEvents between this time (inclusive) and the fromEffectiveAt are returned.
asAtTimeThe asAt time for which the result is valid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfConstituentsAdjustmentHeader

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ ListConstituentsAdjustmentsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfConstituentsAdjustmentHeader> Lusid.Sdk.Api.ReferencePortfolioApi.ListConstituentsAdjustmentsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAtTime = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

ListConstituentsAdjustments: List constituents adjustments List adjustments made to constituents in a reference portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
fromEffectiveAtEvents between this time (inclusive) and the toEffectiveAt are returned.
toEffectiveAtEvents between this time (inclusive) and the fromEffectiveAt are returned.
asAtTimeThe asAt time for which the result is valid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfConstituentsAdjustmentHeader

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ ListConstituentsAdjustmentsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfConstituentsAdjustmentHeader> > Lusid.Sdk.Api.ReferencePortfolioApi.ListConstituentsAdjustmentsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAtTime = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

ListConstituentsAdjustments: List constituents adjustments List adjustments made to constituents in a reference portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
fromEffectiveAtEvents between this time (inclusive) and the toEffectiveAt are returned.
toEffectiveAtEvents between this time (inclusive) and the fromEffectiveAt are returned.
asAtTimeThe asAt time for which the result is valid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfConstituentsAdjustmentHeader)

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ UpsertReferencePortfolioConstituentProperties()

UpsertReferencePortfolioConstituentPropertiesResponse Lusid.Sdk.Api.ReferencePortfolioApi.UpsertReferencePortfolioConstituentProperties ( string  scope,
string  code,
UpsertReferencePortfolioConstituentPropertiesRequest  upsertReferencePortfolioConstituentPropertiesRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentPropertiesRequestThe request to modify properties for the constituent.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
UpsertReferencePortfolioConstituentPropertiesResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ UpsertReferencePortfolioConstituentPropertiesAsync()

async System.Threading.Tasks.Task<UpsertReferencePortfolioConstituentPropertiesResponse> Lusid.Sdk.Api.ReferencePortfolioApi.UpsertReferencePortfolioConstituentPropertiesAsync ( string  scope,
string  code,
UpsertReferencePortfolioConstituentPropertiesRequest  upsertReferencePortfolioConstituentPropertiesRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentPropertiesRequestThe request to modify properties for the constituent.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of UpsertReferencePortfolioConstituentPropertiesResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ UpsertReferencePortfolioConstituentPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertReferencePortfolioConstituentPropertiesResponse> Lusid.Sdk.Api.ReferencePortfolioApi.UpsertReferencePortfolioConstituentPropertiesWithHttpInfo ( string  scope,
string  code,
UpsertReferencePortfolioConstituentPropertiesRequest  upsertReferencePortfolioConstituentPropertiesRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentPropertiesRequestThe request to modify properties for the constituent.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of UpsertReferencePortfolioConstituentPropertiesResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ UpsertReferencePortfolioConstituentPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertReferencePortfolioConstituentPropertiesResponse> > Lusid.Sdk.Api.ReferencePortfolioApi.UpsertReferencePortfolioConstituentPropertiesWithHttpInfoAsync ( string  scope,
string  code,
UpsertReferencePortfolioConstituentPropertiesRequest  upsertReferencePortfolioConstituentPropertiesRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentPropertiesRequestThe request to modify properties for the constituent.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (UpsertReferencePortfolioConstituentPropertiesResponse)

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ UpsertReferencePortfolioConstituents()

UpsertReferencePortfolioConstituentsResponse Lusid.Sdk.Api.ReferencePortfolioApi.UpsertReferencePortfolioConstituents ( string  scope,
string  code,
UpsertReferencePortfolioConstituentsRequest  upsertReferencePortfolioConstituentsRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents Add constituents to a reference portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentsRequestThe constituents to upload to the reference portfolio.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
UpsertReferencePortfolioConstituentsResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ UpsertReferencePortfolioConstituentsAsync()

async System.Threading.Tasks.Task<UpsertReferencePortfolioConstituentsResponse> Lusid.Sdk.Api.ReferencePortfolioApi.UpsertReferencePortfolioConstituentsAsync ( string  scope,
string  code,
UpsertReferencePortfolioConstituentsRequest  upsertReferencePortfolioConstituentsRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents Add constituents to a reference portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentsRequestThe constituents to upload to the reference portfolio.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of UpsertReferencePortfolioConstituentsResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

◆ UpsertReferencePortfolioConstituentsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertReferencePortfolioConstituentsResponse> Lusid.Sdk.Api.ReferencePortfolioApi.UpsertReferencePortfolioConstituentsWithHttpInfo ( string  scope,
string  code,
UpsertReferencePortfolioConstituentsRequest  upsertReferencePortfolioConstituentsRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents Add constituents to a reference portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentsRequestThe constituents to upload to the reference portfolio.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of UpsertReferencePortfolioConstituentsResponse

Implements Lusid.Sdk.Api.IReferencePortfolioApiSync.

◆ UpsertReferencePortfolioConstituentsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertReferencePortfolioConstituentsResponse> > Lusid.Sdk.Api.ReferencePortfolioApi.UpsertReferencePortfolioConstituentsWithHttpInfoAsync ( string  scope,
string  code,
UpsertReferencePortfolioConstituentsRequest  upsertReferencePortfolioConstituentsRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents Add constituents to a reference portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the reference portfolio.
codeThe code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio.
upsertReferencePortfolioConstituentsRequestThe constituents to upload to the reference portfolio.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (UpsertReferencePortfolioConstituentsResponse)

Implements Lusid.Sdk.Api.IReferencePortfolioApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.ReferencePortfolioApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.ReferencePortfolioApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.ReferencePortfolioApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.ReferencePortfolioApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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