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

Inheritance diagram for Lusid.Sdk.Api.IFundConfigurationApiSync:

[legend]

Public Member Functions
FundConfiguration	CreateFundConfiguration (string scope, FundConfigurationRequest fundConfigurationRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateFundConfiguration: Create a FundConfiguration. More...

Lusid.Sdk.Client.ApiResponse< FundConfiguration >	CreateFundConfigurationWithHttpInfo (string scope, FundConfigurationRequest fundConfigurationRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateFundConfiguration: Create a FundConfiguration. More...

DeletedEntityResponse	DeleteFundConfiguration (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteFundConfigurationWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration. More...

FundConfiguration	GetFundConfiguration (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration. More...

Lusid.Sdk.Client.ApiResponse< FundConfiguration >	GetFundConfigurationWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration. More...

PagedResourceListOfFundConfiguration	ListFundConfigurations (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListFundConfigurations: List FundConfiguration. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfFundConfiguration >	ListFundConfigurationsWithHttpInfo (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListFundConfigurations: List FundConfiguration. More...

FundConfiguration	PatchFundConfiguration (string scope, string code, List< Operation > operation, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] PatchFundConfiguration: Patch Fund Configuration. More...

Lusid.Sdk.Client.ApiResponse< FundConfiguration >	PatchFundConfigurationWithHttpInfo (string scope, string code, List< Operation > operation, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] PatchFundConfiguration: Patch Fund Configuration. More...

FundConfigurationProperties	UpsertFundConfigurationProperties (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertFundConfigurationProperties: Upsert FundConfiguration properties More...

Lusid.Sdk.Client.ApiResponse< FundConfigurationProperties >	UpsertFundConfigurationPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertFundConfigurationProperties: Upsert FundConfiguration properties More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateFundConfiguration()

FundConfiguration Lusid.Sdk.Api.IFundConfigurationApiSync.CreateFundConfiguration	(	string	scope,
		FundConfigurationRequest	fundConfigurationRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateFundConfiguration: Create a FundConfiguration.

Create the given FundConfiguration.

Exceptions

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

Parameters

scope	The scope of the FundConfiguration.
fundConfigurationRequest	The definition of the FundConfiguration.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: FundConfiguration

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ CreateFundConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<FundConfiguration> Lusid.Sdk.Api.IFundConfigurationApiSync.CreateFundConfigurationWithHttpInfo	(	string	scope,
		FundConfigurationRequest	fundConfigurationRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] CreateFundConfiguration: Create a FundConfiguration.

Create the given FundConfiguration.

Exceptions

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

Parameters

scope	The scope of the FundConfiguration.
fundConfigurationRequest	The definition of the FundConfiguration.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of FundConfiguration

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ DeleteFundConfiguration()

DeletedEntityResponse Lusid.Sdk.Api.IFundConfigurationApiSync.DeleteFundConfiguration	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration.

Delete the given FundConfiguration.

Exceptions

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

Parameters

scope	The scope of the FundConfiguration to be deleted.
code	The code of the FundConfiguration to be deleted. Together with the scope this uniquely identifies the FundConfiguration.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ DeleteFundConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IFundConfigurationApiSync.DeleteFundConfigurationWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration.

Delete the given FundConfiguration.

Exceptions

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

Parameters

scope	The scope of the FundConfiguration to be deleted.
code	The code of the FundConfiguration to be deleted. Together with the scope this uniquely identifies the FundConfiguration.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ GetFundConfiguration()

FundConfiguration Lusid.Sdk.Api.IFundConfigurationApiSync.GetFundConfiguration	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration.

Retrieve the definition of a particular FundConfiguration.

Exceptions

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

Parameters

scope	The scope of the FundConfiguration.
code	The code of the FundConfiguration. Together with the scope this uniquely identifies the FundConfiguration.
effectiveAt	The effective datetime or cut label at which to retrieve the FundConfiguration properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the FundConfiguration definition. Defaults to returning the latest version of the FundConfiguration definition if not specified. (optional)
propertyKeys	A list of property keys from the 'FundConfiguration' domain to decorate onto the FundConfiguration. These must take the format {domain}/{scope}/{code}, for example 'FundConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: FundConfiguration

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ GetFundConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<FundConfiguration> Lusid.Sdk.Api.IFundConfigurationApiSync.GetFundConfigurationWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration.

Retrieve the definition of a particular FundConfiguration.

Exceptions

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

Parameters

scope	The scope of the FundConfiguration.
code	The code of the FundConfiguration. Together with the scope this uniquely identifies the FundConfiguration.
effectiveAt	The effective datetime or cut label at which to retrieve the FundConfiguration properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the FundConfiguration definition. Defaults to returning the latest version of the FundConfiguration definition if not specified. (optional)
propertyKeys	A list of property keys from the 'FundConfiguration' domain to decorate onto the FundConfiguration. These must take the format {domain}/{scope}/{code}, for example 'FundConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of FundConfiguration

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ ListFundConfigurations()

PagedResourceListOfFundConfiguration Lusid.Sdk.Api.IFundConfigurationApiSync.ListFundConfigurations	(	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`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListFundConfigurations: List FundConfiguration.

List all the FundConfiguration matching particular criteria.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to list the TimeVariant properties for the FundConfiguration. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the FundConfiguration. Defaults to returning the latest version of each FundConfiguration if not specified. (optional)
page	The pagination token to use to continue listing FundConfiguration; 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)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the FundConfiguration type, specify "id.Code eq 'FundConfiguration1'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	A list of property keys from the 'FundConfiguration' domain to decorate onto each FundConfiguration. These must take the format {domain}/{scope}/{code}, for example 'FundConfiguration/Manager/Id'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfFundConfiguration

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ ListFundConfigurationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfFundConfiguration> Lusid.Sdk.Api.IFundConfigurationApiSync.ListFundConfigurationsWithHttpInfo	(	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`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListFundConfigurations: List FundConfiguration.

List all the FundConfiguration matching particular criteria.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to list the TimeVariant properties for the FundConfiguration. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the FundConfiguration. Defaults to returning the latest version of each FundConfiguration if not specified. (optional)
page	The pagination token to use to continue listing FundConfiguration; 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)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the FundConfiguration type, specify "id.Code eq 'FundConfiguration1'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	A list of property keys from the 'FundConfiguration' domain to decorate onto each FundConfiguration. These must take the format {domain}/{scope}/{code}, for example 'FundConfiguration/Manager/Id'. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfFundConfiguration

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ PatchFundConfiguration()

FundConfiguration Lusid.Sdk.Api.IFundConfigurationApiSync.PatchFundConfiguration	(	string	scope,
		string	code,
		List< Operation >	operation,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] PatchFundConfiguration: Patch Fund Configuration.

Create or update certain fields for a particular FundConfiguration. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, DealingFilters, PnlFilters, BackOutFilters, ExternalFeeFilters.

Exceptions

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

Parameters

scope	The scope of the FundConfiguration.
code	The code of the FundConfiguration. Together with the scope this uniquely identifies the FundConfiguration.
operation	The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: FundConfiguration

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ PatchFundConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<FundConfiguration> Lusid.Sdk.Api.IFundConfigurationApiSync.PatchFundConfigurationWithHttpInfo	(	string	scope,
		string	code,
		List< Operation >	operation,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] PatchFundConfiguration: Patch Fund Configuration.

Create or update certain fields for a particular FundConfiguration. The behaviour is defined by the JSON Patch specification. Currently supported fields are: DisplayName, Description, DealingFilters, PnlFilters, BackOutFilters, ExternalFeeFilters.

Exceptions

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

Parameters

scope	The scope of the FundConfiguration.
code	The code of the FundConfiguration. Together with the scope this uniquely identifies the FundConfiguration.
operation	The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of FundConfiguration

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ UpsertFundConfigurationProperties()

FundConfigurationProperties Lusid.Sdk.Api.IFundConfigurationApiSync.UpsertFundConfigurationProperties	(	string	scope,
		string	code,
		Dictionary< string, Property >?	requestBody = `default(Dictionary< string, Property >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpsertFundConfigurationProperties: Upsert FundConfiguration properties

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

Exceptions

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

Parameters

scope	The scope of the FundConfiguration to update or insert the properties onto.
code	The code of the FundConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the FundConfiguration.
requestBody	The properties to be updated or inserted onto the Fund Configuration. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "FundConfiguration/Manager/Id". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: FundConfigurationProperties

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

◆ UpsertFundConfigurationPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<FundConfigurationProperties> Lusid.Sdk.Api.IFundConfigurationApiSync.UpsertFundConfigurationPropertiesWithHttpInfo	(	string	scope,
		string	code,
		Dictionary< string, Property >?	requestBody = `default(Dictionary< string, Property >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpsertFundConfigurationProperties: Upsert FundConfiguration properties

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

Exceptions

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

Parameters

scope	The scope of the FundConfiguration to update or insert the properties onto.
code	The code of the FundConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the FundConfiguration.
requestBody	The properties to be updated or inserted onto the Fund Configuration. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "FundConfiguration/Manager/Id". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of FundConfigurationProperties

Implemented in Lusid.Sdk.Api.FundConfigurationApi.

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateFundConfiguration()

◆ CreateFundConfigurationWithHttpInfo()

◆ DeleteFundConfiguration()

◆ DeleteFundConfigurationWithHttpInfo()

◆ GetFundConfiguration()

◆ GetFundConfigurationWithHttpInfo()

◆ ListFundConfigurations()

◆ ListFundConfigurationsWithHttpInfo()

◆ PatchFundConfiguration()

◆ PatchFundConfigurationWithHttpInfo()

◆ UpsertFundConfigurationProperties()

◆ UpsertFundConfigurationPropertiesWithHttpInfo()