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

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

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

Public Member Functions

 CustomDataModelsApi ()
 Initializes a new instance of the CustomDataModelsApi class. More...
 
 CustomDataModelsApi (string basePath)
 Initializes a new instance of the CustomDataModelsApi class. More...
 
 CustomDataModelsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the CustomDataModelsApi class using Configuration object More...
 
 CustomDataModelsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the CustomDataModelsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
BatchAmendCustomDataModelMembershipResponse BatchAmend (string successMode, Dictionary< string, MembershipAmendmentRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. More...
 
Lusid.Sdk.Client.ApiResponse< BatchAmendCustomDataModelMembershipResponseBatchAmendWithHttpInfo (string successMode, Dictionary< string, MembershipAmendmentRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. More...
 
async System.Threading.Tasks.Task< BatchAmendCustomDataModelMembershipResponseBatchAmendAsync (string successMode, Dictionary< string, MembershipAmendmentRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< BatchAmendCustomDataModelMembershipResponse > > BatchAmendWithHttpInfoAsync (string successMode, Dictionary< string, MembershipAmendmentRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. More...
 
CustomDataModel CreateCustomDataModel (string entityType, CreateCustomDataModelRequest? createCustomDataModelRequest=default(CreateCustomDataModelRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model Creates a Custom Data Model. More...
 
Lusid.Sdk.Client.ApiResponse< CustomDataModelCreateCustomDataModelWithHttpInfo (string entityType, CreateCustomDataModelRequest? createCustomDataModelRequest=default(CreateCustomDataModelRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model Creates a Custom Data Model. More...
 
async System.Threading.Tasks.Task< CustomDataModelCreateCustomDataModelAsync (string entityType, CreateCustomDataModelRequest? createCustomDataModelRequest=default(CreateCustomDataModelRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model Creates a Custom Data Model. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomDataModel > > CreateCustomDataModelWithHttpInfoAsync (string entityType, CreateCustomDataModelRequest? createCustomDataModelRequest=default(CreateCustomDataModelRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model Creates a Custom Data Model. More...
 
DeletedEntityResponse DeleteCustomDataModel (string entityType, string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteCustomDataModelWithHttpInfo (string entityType, string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteCustomDataModelAsync (string entityType, string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteCustomDataModelWithHttpInfoAsync (string entityType, string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. More...
 
CustomDataModel GetCustomDataModel (string entityType, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model Retrieves a Custom Data Model at a given as at time. More...
 
Lusid.Sdk.Client.ApiResponse< CustomDataModelGetCustomDataModelWithHttpInfo (string entityType, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model Retrieves a Custom Data Model at a given as at time. More...
 
async System.Threading.Tasks.Task< CustomDataModelGetCustomDataModelAsync (string entityType, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model Retrieves a Custom Data Model at a given as at time. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomDataModel > > GetCustomDataModelWithHttpInfoAsync (string entityType, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model Retrieves a Custom Data Model at a given as at time. More...
 
ResourceListOfDataModelSummary ListDataModelHierarchies (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. Lists the data model summaries within their hierarchical structure. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfDataModelSummaryListDataModelHierarchiesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. Lists the data model summaries within their hierarchical structure. More...
 
async System.Threading.Tasks.Task< ResourceListOfDataModelSummaryListDataModelHierarchiesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. Lists the data model summaries within their hierarchical structure. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfDataModelSummary > > ListDataModelHierarchiesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. Lists the data model summaries within their hierarchical structure. More...
 
ResourceListOfString ListSupportedEntityTypes (int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. Lists the currently supported entity types available to bind with Custom Data Models. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfStringListSupportedEntityTypesWithHttpInfo (int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. Lists the currently supported entity types available to bind with Custom Data Models. More...
 
async System.Threading.Tasks.Task< ResourceListOfStringListSupportedEntityTypesAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. Lists the currently supported entity types available to bind with Custom Data Models. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfString > > ListSupportedEntityTypesWithHttpInfoAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. Lists the currently supported entity types available to bind with Custom Data Models. More...
 
CustomDataModel UpdateCustomDataModel (string entityType, string scope, string code, UpdateCustomDataModelRequest? updateCustomDataModelRequest=default(UpdateCustomDataModelRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model Updates a Custom Data Model. More...
 
Lusid.Sdk.Client.ApiResponse< CustomDataModelUpdateCustomDataModelWithHttpInfo (string entityType, string scope, string code, UpdateCustomDataModelRequest? updateCustomDataModelRequest=default(UpdateCustomDataModelRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model Updates a Custom Data Model. More...
 
async System.Threading.Tasks.Task< CustomDataModelUpdateCustomDataModelAsync (string entityType, string scope, string code, UpdateCustomDataModelRequest? updateCustomDataModelRequest=default(UpdateCustomDataModelRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model Updates a Custom Data Model. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CustomDataModel > > UpdateCustomDataModelWithHttpInfoAsync (string entityType, string scope, string code, UpdateCustomDataModelRequest? updateCustomDataModelRequest=default(UpdateCustomDataModelRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model Updates a Custom Data Model. 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

◆ CustomDataModelsApi() [1/4]

Lusid.Sdk.Api.CustomDataModelsApi.CustomDataModelsApi ( )
inline

Initializes a new instance of the CustomDataModelsApi class.

Returns

◆ CustomDataModelsApi() [2/4]

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

Initializes a new instance of the CustomDataModelsApi class.

Returns

◆ CustomDataModelsApi() [3/4]

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

Initializes a new instance of the CustomDataModelsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ CustomDataModelsApi() [4/4]

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

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

◆ BatchAmend()

BatchAmendCustomDataModelMembershipResponse Lusid.Sdk.Api.CustomDataModelsApi.BatchAmend ( string  successMode,
Dictionary< string, MembershipAmendmentRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
requestBodyThe payload describing the amendments to make for the given Custom Data Model.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
BatchAmendCustomDataModelMembershipResponse

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ BatchAmendAsync()

async System.Threading.Tasks.Task<BatchAmendCustomDataModelMembershipResponse> Lusid.Sdk.Api.CustomDataModelsApi.BatchAmendAsync ( string  successMode,
Dictionary< string, MembershipAmendmentRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
requestBodyThe payload describing the amendments to make for the given Custom Data Model.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of BatchAmendCustomDataModelMembershipResponse

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ BatchAmendWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BatchAmendCustomDataModelMembershipResponse> Lusid.Sdk.Api.CustomDataModelsApi.BatchAmendWithHttpInfo ( string  successMode,
Dictionary< string, MembershipAmendmentRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
requestBodyThe payload describing the amendments to make for the given Custom Data Model.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of BatchAmendCustomDataModelMembershipResponse

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ BatchAmendWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<BatchAmendCustomDataModelMembershipResponse> > Lusid.Sdk.Api.CustomDataModelsApi.BatchAmendWithHttpInfoAsync ( string  successMode,
Dictionary< string, MembershipAmendmentRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
requestBodyThe payload describing the amendments to make for the given Custom Data Model.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (BatchAmendCustomDataModelMembershipResponse)

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ CreateCustomDataModel()

CustomDataModel Lusid.Sdk.Api.CustomDataModelsApi.CreateCustomDataModel ( string  entityType,
CreateCustomDataModelRequest createCustomDataModelRequest = default(CreateCustomDataModelRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model Creates a Custom Data Model.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
createCustomDataModelRequestThe request containing the details of the Data Model. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ CreateCustomDataModelAsync()

async System.Threading.Tasks.Task<CustomDataModel> Lusid.Sdk.Api.CustomDataModelsApi.CreateCustomDataModelAsync ( string  entityType,
CreateCustomDataModelRequest createCustomDataModelRequest = default(CreateCustomDataModelRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model Creates a Custom Data Model.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
createCustomDataModelRequestThe request containing the details of the Data Model. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ CreateCustomDataModelWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomDataModel> Lusid.Sdk.Api.CustomDataModelsApi.CreateCustomDataModelWithHttpInfo ( string  entityType,
CreateCustomDataModelRequest createCustomDataModelRequest = default(CreateCustomDataModelRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model Creates a Custom Data Model.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
createCustomDataModelRequestThe request containing the details of the Data Model. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ CreateCustomDataModelWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomDataModel> > Lusid.Sdk.Api.CustomDataModelsApi.CreateCustomDataModelWithHttpInfoAsync ( string  entityType,
CreateCustomDataModelRequest createCustomDataModelRequest = default(CreateCustomDataModelRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model Creates a Custom Data Model.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
createCustomDataModelRequestThe request containing the details of the Data Model. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (CustomDataModel)

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ DeleteCustomDataModel()

DeletedEntityResponse Lusid.Sdk.Api.CustomDataModelsApi.DeleteCustomDataModel ( string  entityType,
string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ DeleteCustomDataModelAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.CustomDataModelsApi.DeleteCustomDataModelAsync ( string  entityType,
string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ DeleteCustomDataModelWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.CustomDataModelsApi.DeleteCustomDataModelWithHttpInfo ( string  entityType,
string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ DeleteCustomDataModelWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.CustomDataModelsApi.DeleteCustomDataModelWithHttpInfoAsync ( string  entityType,
string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ GetBasePath()

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

Gets the base path of the API client.

The base path

◆ GetCustomDataModel()

CustomDataModel Lusid.Sdk.Api.CustomDataModelsApi.GetCustomDataModel ( string  entityType,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model Retrieves a Custom Data Model at a given as at time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
asAtThe asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ GetCustomDataModelAsync()

async System.Threading.Tasks.Task<CustomDataModel> Lusid.Sdk.Api.CustomDataModelsApi.GetCustomDataModelAsync ( string  entityType,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model Retrieves a Custom Data Model at a given as at time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
asAtThe asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ GetCustomDataModelWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomDataModel> Lusid.Sdk.Api.CustomDataModelsApi.GetCustomDataModelWithHttpInfo ( string  entityType,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model Retrieves a Custom Data Model at a given as at time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
asAtThe asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ GetCustomDataModelWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomDataModel> > Lusid.Sdk.Api.CustomDataModelsApi.GetCustomDataModelWithHttpInfoAsync ( string  entityType,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model Retrieves a Custom Data Model at a given as at time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
asAtThe asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (CustomDataModel)

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ ListDataModelHierarchies()

ResourceListOfDataModelSummary Lusid.Sdk.Api.CustomDataModelsApi.ListDataModelHierarchies ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. Lists the data model summaries within their hierarchical structure.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
filterExpression to filter the results. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfDataModelSummary

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ ListDataModelHierarchiesAsync()

async System.Threading.Tasks.Task<ResourceListOfDataModelSummary> Lusid.Sdk.Api.CustomDataModelsApi.ListDataModelHierarchiesAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. Lists the data model summaries within their hierarchical structure.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
filterExpression to filter the results. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfDataModelSummary

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ ListDataModelHierarchiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfDataModelSummary> Lusid.Sdk.Api.CustomDataModelsApi.ListDataModelHierarchiesWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. Lists the data model summaries within their hierarchical structure.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
filterExpression to filter the results. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfDataModelSummary

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ ListDataModelHierarchiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfDataModelSummary> > Lusid.Sdk.Api.CustomDataModelsApi.ListDataModelHierarchiesWithHttpInfoAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. Lists the data model summaries within their hierarchical structure.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified. (optional)
filterExpression to filter the results. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfDataModelSummary)

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ ListSupportedEntityTypes()

ResourceListOfString Lusid.Sdk.Api.CustomDataModelsApi.ListSupportedEntityTypes ( int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. Lists the currently supported entity types available to bind with Custom Data Models.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfString

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ ListSupportedEntityTypesAsync()

async System.Threading.Tasks.Task<ResourceListOfString> Lusid.Sdk.Api.CustomDataModelsApi.ListSupportedEntityTypesAsync ( int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. Lists the currently supported entity types available to bind with Custom Data Models.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfString

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ ListSupportedEntityTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfString> Lusid.Sdk.Api.CustomDataModelsApi.ListSupportedEntityTypesWithHttpInfo ( int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. Lists the currently supported entity types available to bind with Custom Data Models.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfString

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ ListSupportedEntityTypesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfString> > Lusid.Sdk.Api.CustomDataModelsApi.ListSupportedEntityTypesWithHttpInfoAsync ( int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. Lists the currently supported entity types available to bind with Custom Data Models.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfString)

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ UpdateCustomDataModel()

CustomDataModel Lusid.Sdk.Api.CustomDataModelsApi.UpdateCustomDataModel ( string  entityType,
string  scope,
string  code,
UpdateCustomDataModelRequest updateCustomDataModelRequest = default(UpdateCustomDataModelRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model Updates a Custom Data Model.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
updateCustomDataModelRequestThe request containing the details of the Data Model. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ UpdateCustomDataModelAsync()

async System.Threading.Tasks.Task<CustomDataModel> Lusid.Sdk.Api.CustomDataModelsApi.UpdateCustomDataModelAsync ( string  entityType,
string  scope,
string  code,
UpdateCustomDataModelRequest updateCustomDataModelRequest = default(UpdateCustomDataModelRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model Updates a Custom Data Model.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
updateCustomDataModelRequestThe request containing the details of the Data Model. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

◆ UpdateCustomDataModelWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CustomDataModel> Lusid.Sdk.Api.CustomDataModelsApi.UpdateCustomDataModelWithHttpInfo ( string  entityType,
string  scope,
string  code,
UpdateCustomDataModelRequest updateCustomDataModelRequest = default(UpdateCustomDataModelRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model Updates a Custom Data Model.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
updateCustomDataModelRequestThe request containing the details of the Data Model. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of CustomDataModel

Implements Lusid.Sdk.Api.ICustomDataModelsApiSync.

◆ UpdateCustomDataModelWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CustomDataModel> > Lusid.Sdk.Api.CustomDataModelsApi.UpdateCustomDataModelWithHttpInfoAsync ( string  entityType,
string  scope,
string  code,
UpdateCustomDataModelRequest updateCustomDataModelRequest = default(UpdateCustomDataModelRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model Updates a Custom Data Model.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type of the Data Model.
scopeThe scope of the specified Data Model.
codeThe code of the specified Data Model.
updateCustomDataModelRequestThe request containing the details of the Data Model. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (CustomDataModel)

Implements Lusid.Sdk.Api.ICustomDataModelsApiAsync.

Property Documentation

◆ AsynchronousClient

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

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.CustomDataModelsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

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

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.CustomDataModelsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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