LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IFundsApiAsync Interface Reference

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

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

Public Member Functions

System.Threading.Tasks.Task< ValuationPointDataResponseAcceptEstimatePointAsync (string scope, string code, ValuationPointDataRequest valuationPointDataRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] AcceptEstimatePoint: Accepts an Estimate Valuation Point. More...
 
System.Threading.Tasks.Task< ApiResponse< ValuationPointDataResponse > > AcceptEstimatePointWithHttpInfoAsync (string scope, string code, ValuationPointDataRequest valuationPointDataRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] AcceptEstimatePoint: Accepts an Estimate Valuation Point. More...
 
System.Threading.Tasks.Task< FundCreateFundAsync (string scope, FundRequest fundRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] CreateFund: Create a Fund. More...
 
System.Threading.Tasks.Task< ApiResponse< Fund > > CreateFundWithHttpInfoAsync (string scope, FundRequest fundRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] CreateFund: Create a Fund. More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteFundAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteFund: Delete a Fund. More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteFundWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteFund: Delete a Fund. More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteValuationPointAsync (string scope, string code, string diaryEntryCode, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point. More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteValuationPointWithHttpInfoAsync (string scope, string code, string diaryEntryCode, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point. More...
 
System.Threading.Tasks.Task< ValuationPointDataResponseFinaliseCandidateValuationAsync (string scope, string code, ValuationPointDataRequest valuationPointDataRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] FinaliseCandidateValuation: Finalise Candidate. More...
 
System.Threading.Tasks.Task< ApiResponse< ValuationPointDataResponse > > FinaliseCandidateValuationWithHttpInfoAsync (string scope, string code, ValuationPointDataRequest valuationPointDataRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] FinaliseCandidateValuation: Finalise Candidate. More...
 
System.Threading.Tasks.Task< FundGetFundAsync (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))
 [EXPERIMENTAL] GetFund: Get a Fund. More...
 
System.Threading.Tasks.Task< ApiResponse< Fund > > GetFundWithHttpInfoAsync (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))
 [EXPERIMENTAL] GetFund: Get a Fund. More...
 
System.Threading.Tasks.Task< ValuationPointDataResponseGetValuationPointDataAsync (string scope, string code, ValuationPointDataQueryParameters valuationPointDataQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund. More...
 
System.Threading.Tasks.Task< ApiResponse< ValuationPointDataResponse > > GetValuationPointDataWithHttpInfoAsync (string scope, string code, ValuationPointDataQueryParameters valuationPointDataQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund. More...
 
System.Threading.Tasks.Task< PagedResourceListOfFundListFundsAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListFunds: List Funds. More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfFund > > ListFundsWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListFunds: List Funds. More...
 
System.Threading.Tasks.Task< FundSetShareClassInstrumentsAsync (string scope, string code, SetShareClassInstrumentsRequest setShareClassInstrumentsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund. More...
 
System.Threading.Tasks.Task< ApiResponse< Fund > > SetShareClassInstrumentsWithHttpInfoAsync (string scope, string code, SetShareClassInstrumentsRequest setShareClassInstrumentsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund. More...
 
System.Threading.Tasks.Task< FundPropertiesUpsertFundPropertiesAsync (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties. More...
 
System.Threading.Tasks.Task< ApiResponse< FundProperties > > UpsertFundPropertiesWithHttpInfoAsync (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties. More...
 
System.Threading.Tasks.Task< DiaryEntryUpsertValuationPointAsync (string scope, string code, UpsertValuationPointRequest upsertValuationPointRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertValuationPoint: Upsert Valuation Point. More...
 
System.Threading.Tasks.Task< ApiResponse< DiaryEntry > > UpsertValuationPointWithHttpInfoAsync (string scope, string code, UpsertValuationPointRequest upsertValuationPointRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertValuationPoint: Upsert Valuation Point. 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

◆ AcceptEstimatePointAsync()

System.Threading.Tasks.Task<ValuationPointDataResponse> Lusid.Sdk.Api.IFundsApiAsync.AcceptEstimatePointAsync ( string  scope,
string  code,
ValuationPointDataRequest  valuationPointDataRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] AcceptEstimatePoint: Accepts an Estimate Valuation Point.

Accepts the specified estimate Valuation Point. Should the Valuation Point differ since the valuation Point was last run, status will be marked as &#39;Candidate&#39;, otherwise it will be marked as &#39;Final&#39;

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
valuationPointDataRequestThe valuationPointDataRequest which contains the Diary Entry code for the Estimate Valuation Point to move to Final state.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ValuationPointDataResponse

Implemented in Lusid.Sdk.Api.FundsApi.

◆ AcceptEstimatePointWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ValuationPointDataResponse> > Lusid.Sdk.Api.IFundsApiAsync.AcceptEstimatePointWithHttpInfoAsync ( string  scope,
string  code,
ValuationPointDataRequest  valuationPointDataRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] AcceptEstimatePoint: Accepts an Estimate Valuation Point.

Accepts the specified estimate Valuation Point. Should the Valuation Point differ since the valuation Point was last run, status will be marked as &#39;Candidate&#39;, otherwise it will be marked as &#39;Final&#39;

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
valuationPointDataRequestThe valuationPointDataRequest which contains the Diary Entry code for the Estimate Valuation Point to move to Final state.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ValuationPointDataResponse)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ CreateFundAsync()

System.Threading.Tasks.Task<Fund> Lusid.Sdk.Api.IFundsApiAsync.CreateFundAsync ( string  scope,
FundRequest  fundRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] CreateFund: Create a Fund.

Create the given Fund.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
fundRequestThe definition of the Fund.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Fund

Implemented in Lusid.Sdk.Api.FundsApi.

◆ CreateFundWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Fund> > Lusid.Sdk.Api.IFundsApiAsync.CreateFundWithHttpInfoAsync ( string  scope,
FundRequest  fundRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] CreateFund: Create a Fund.

Create the given Fund.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
fundRequestThe definition of the Fund.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Fund)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ DeleteFundAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IFundsApiAsync.DeleteFundAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] DeleteFund: Delete a Fund.

Delete the given Fund.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund to be deleted.
codeThe code of the Fund to be deleted. Together with the scope this uniquely identifies the Fund.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.FundsApi.

◆ DeleteFundWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IFundsApiAsync.DeleteFundWithHttpInfoAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] DeleteFund: Delete a Fund.

Delete the given Fund.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund to be deleted.
codeThe code of the Fund to be deleted. Together with the scope this uniquely identifies the Fund.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ DeleteValuationPointAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IFundsApiAsync.DeleteValuationPointAsync ( string  scope,
string  code,
string  diaryEntryCode,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point.

Deletes the given Valuation Point.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund for the valuation point to be deleted.
codeThe code of the Fund containing the Valuation Point to be deleted. Together with the scope this uniquely identifies the Fund.
diaryEntryCodeThe diary entry code for the valuation Point to be deleted.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.FundsApi.

◆ DeleteValuationPointWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IFundsApiAsync.DeleteValuationPointWithHttpInfoAsync ( string  scope,
string  code,
string  diaryEntryCode,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point.

Deletes the given Valuation Point.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund for the valuation point to be deleted.
codeThe code of the Fund containing the Valuation Point to be deleted. Together with the scope this uniquely identifies the Fund.
diaryEntryCodeThe diary entry code for the valuation Point to be deleted.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ FinaliseCandidateValuationAsync()

System.Threading.Tasks.Task<ValuationPointDataResponse> Lusid.Sdk.Api.IFundsApiAsync.FinaliseCandidateValuationAsync ( string  scope,
string  code,
ValuationPointDataRequest  valuationPointDataRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] FinaliseCandidateValuation: Finalise Candidate.

Moves a &#39;Candidate&#39; status Valuation Point to status &#39;Final&#39;.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
valuationPointDataRequestThe valuationPointDataRequest which contains the diary entry code to mark as final.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ValuationPointDataResponse

Implemented in Lusid.Sdk.Api.FundsApi.

◆ FinaliseCandidateValuationWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ValuationPointDataResponse> > Lusid.Sdk.Api.IFundsApiAsync.FinaliseCandidateValuationWithHttpInfoAsync ( string  scope,
string  code,
ValuationPointDataRequest  valuationPointDataRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] FinaliseCandidateValuation: Finalise Candidate.

Moves a &#39;Candidate&#39; status Valuation Point to status &#39;Final&#39;.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
valuationPointDataRequestThe valuationPointDataRequest which contains the diary entry code to mark as final.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ValuationPointDataResponse)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ GetFundAsync()

System.Threading.Tasks.Task<Fund> Lusid.Sdk.Api.IFundsApiAsync.GetFundAsync ( 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) 
)

[EXPERIMENTAL] GetFund: Get a Fund.

Retrieve the definition of a particular Fund.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
effectiveAtThe effective datetime or cut label at which to retrieve the Fund properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Fund&#39; domain to decorate onto the Fund. These must take the format {domain}/{scope}/{code}, for example &#39;Fund/Manager/Id&#39;. If no properties are specified, then no properties will be returned. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Fund

Implemented in Lusid.Sdk.Api.FundsApi.

◆ GetFundWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Fund> > Lusid.Sdk.Api.IFundsApiAsync.GetFundWithHttpInfoAsync ( 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) 
)

[EXPERIMENTAL] GetFund: Get a Fund.

Retrieve the definition of a particular Fund.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
effectiveAtThe effective datetime or cut label at which to retrieve the Fund properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Fund&#39; domain to decorate onto the Fund. These must take the format {domain}/{scope}/{code}, for example &#39;Fund/Manager/Id&#39;. If no properties are specified, then no properties will be returned. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Fund)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ GetValuationPointDataAsync()

System.Threading.Tasks.Task<ValuationPointDataResponse> Lusid.Sdk.Api.IFundsApiAsync.GetValuationPointDataAsync ( string  scope,
string  code,
ValuationPointDataQueryParameters  valuationPointDataQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund.

Retrieves the Valuation Point data for a date or specified Diary Entry Id. The endpoint will internally extract all &#39;Assets&#39; and &#39;Liabilities&#39; from the related ABOR&#39;s Trial balance to produce a GAV. Start date will be assumed from the last &#39;official&#39; DiaryEntry and EndDate will be as provided.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
valuationPointDataQueryParametersThe arguments to use for querying the Valuation Point data
asAtThe asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ValuationPointDataResponse

Implemented in Lusid.Sdk.Api.FundsApi.

◆ GetValuationPointDataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ValuationPointDataResponse> > Lusid.Sdk.Api.IFundsApiAsync.GetValuationPointDataWithHttpInfoAsync ( string  scope,
string  code,
ValuationPointDataQueryParameters  valuationPointDataQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund.

Retrieves the Valuation Point data for a date or specified Diary Entry Id. The endpoint will internally extract all &#39;Assets&#39; and &#39;Liabilities&#39; from the related ABOR&#39;s Trial balance to produce a GAV. Start date will be assumed from the last &#39;official&#39; DiaryEntry and EndDate will be as provided.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
valuationPointDataQueryParametersThe arguments to use for querying the Valuation Point data
asAtThe asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ValuationPointDataResponse)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ ListFundsAsync()

System.Threading.Tasks.Task<PagedResourceListOfFund> Lusid.Sdk.Api.IFundsApiAsync.ListFundsAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListFunds: List Funds.

List all the Funds matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the TimeVariant properties for the Funds. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the Funds. Defaults to returning the latest version of each Fund if not specified. (optional)
pageThe pagination token to use to continue listing Funds; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Fund type, specify &quot;id.Code eq &#39;Fund1&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
propertyKeysA list of property keys from the &#39;Fund&#39; domain to decorate onto each Fund. These must take the format {domain}/{scope}/{code}, for example &#39;Fund/Manager/Id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfFund

Implemented in Lusid.Sdk.Api.FundsApi.

◆ ListFundsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfFund> > Lusid.Sdk.Api.IFundsApiAsync.ListFundsWithHttpInfoAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListFunds: List Funds.

List all the Funds matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the TimeVariant properties for the Funds. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the Funds. Defaults to returning the latest version of each Fund if not specified. (optional)
pageThe pagination token to use to continue listing Funds; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the Fund type, specify &quot;id.Code eq &#39;Fund1&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
propertyKeysA list of property keys from the &#39;Fund&#39; domain to decorate onto each Fund. These must take the format {domain}/{scope}/{code}, for example &#39;Fund/Manager/Id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfFund)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ SetShareClassInstrumentsAsync()

System.Threading.Tasks.Task<Fund> Lusid.Sdk.Api.IFundsApiAsync.SetShareClassInstrumentsAsync ( string  scope,
string  code,
SetShareClassInstrumentsRequest  setShareClassInstrumentsRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund.

Update the ShareClass Instruments on an existing fund with the set of instruments provided.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund.
setShareClassInstrumentsRequestThe scopes and instrument identifiers for the instruments to be set.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Fund

Implemented in Lusid.Sdk.Api.FundsApi.

◆ SetShareClassInstrumentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Fund> > Lusid.Sdk.Api.IFundsApiAsync.SetShareClassInstrumentsWithHttpInfoAsync ( string  scope,
string  code,
SetShareClassInstrumentsRequest  setShareClassInstrumentsRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund.

Update the ShareClass Instruments on an existing fund with the set of instruments provided.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund.
setShareClassInstrumentsRequestThe scopes and instrument identifiers for the instruments to be set.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Fund)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ UpsertFundPropertiesAsync()

System.Threading.Tasks.Task<FundProperties> Lusid.Sdk.Api.IFundsApiAsync.UpsertFundPropertiesAsync ( string  scope,
string  code,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties.

Update or insert one or more properties onto a single Fund. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain &#39;Fund&#39;. Upserting a property that exists for an Fund, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund to update or insert the properties onto.
codeThe code of the Fund to update or insert the properties onto. Together with the scope this uniquely identifies the Fund.
requestBodyThe properties to be updated or inserted onto the Fund. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. &quot;Fund/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of FundProperties

Implemented in Lusid.Sdk.Api.FundsApi.

◆ UpsertFundPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<FundProperties> > Lusid.Sdk.Api.IFundsApiAsync.UpsertFundPropertiesWithHttpInfoAsync ( string  scope,
string  code,
Dictionary< string, Property >?  requestBody = default(Dictionary< string, Property >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties.

Update or insert one or more properties onto a single Fund. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain &#39;Fund&#39;. Upserting a property that exists for an Fund, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund to update or insert the properties onto.
codeThe code of the Fund to update or insert the properties onto. Together with the scope this uniquely identifies the Fund.
requestBodyThe properties to be updated or inserted onto the Fund. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. &quot;Fund/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (FundProperties)

Implemented in Lusid.Sdk.Api.FundsApi.

◆ UpsertValuationPointAsync()

System.Threading.Tasks.Task<DiaryEntry> Lusid.Sdk.Api.IFundsApiAsync.UpsertValuationPointAsync ( string  scope,
string  code,
UpsertValuationPointRequest  upsertValuationPointRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertValuationPoint: Upsert Valuation Point.

Update or insert the estimate Valuation Point. If the Valuation Point does not exist, this method will create it in estimate state. If the Valuation Point already exists and is in estimate state, the Valuation Point will be updated with the newly specified information in this request.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
upsertValuationPointRequestThe Valuation Point Estimate definition to Upsert
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DiaryEntry

Implemented in Lusid.Sdk.Api.FundsApi.

◆ UpsertValuationPointWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DiaryEntry> > Lusid.Sdk.Api.IFundsApiAsync.UpsertValuationPointWithHttpInfoAsync ( string  scope,
string  code,
UpsertValuationPointRequest  upsertValuationPointRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] UpsertValuationPoint: Upsert Valuation Point.

Update or insert the estimate Valuation Point. If the Valuation Point does not exist, this method will create it in estimate state. If the Valuation Point already exists and is in estimate state, the Valuation Point will be updated with the newly specified information in this request.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Fund.
codeThe code of the Fund. Together with the scope this uniquely identifies the Fund.
upsertValuationPointRequestThe Valuation Point Estimate definition to Upsert
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DiaryEntry)

Implemented in Lusid.Sdk.Api.FundsApi.


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