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

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

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

Public Member Functions

 RelationshipsApi ()
 Initializes a new instance of the RelationshipsApi class. More...
 
 RelationshipsApi (string basePath)
 Initializes a new instance of the RelationshipsApi class. More...
 
 RelationshipsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the RelationshipsApi class using Configuration object More...
 
 RelationshipsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the RelationshipsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
CompleteRelationship CreateRelationship (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0)
 CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers More...
 
Lusid.Sdk.Client.ApiResponse< CompleteRelationshipCreateRelationshipWithHttpInfo (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0)
 CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers More...
 
async System.Threading.Tasks.Task< CompleteRelationshipCreateRelationshipAsync (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CompleteRelationship > > CreateRelationshipWithHttpInfoAsync (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers More...
 
DeletedEntityResponse DeleteRelationship (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0)
 [EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteRelationshipWithHttpInfo (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0)
 [EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteRelationshipAsync (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteRelationshipWithHttpInfoAsync (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers 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...
 
- 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

Constructor & Destructor Documentation

◆ RelationshipsApi() [1/4]

Lusid.Sdk.Api.RelationshipsApi.RelationshipsApi ( )
inline

Initializes a new instance of the RelationshipsApi class.

Returns

◆ RelationshipsApi() [2/4]

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

Initializes a new instance of the RelationshipsApi class.

Returns

◆ RelationshipsApi() [3/4]

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

Initializes a new instance of the RelationshipsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ RelationshipsApi() [4/4]

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

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

◆ CreateRelationship()

CompleteRelationship Lusid.Sdk.Api.RelationshipsApi.CreateRelationship ( string  scope,
string  code,
CreateRelationshipRequest  createRelationshipRequest,
int  operationIndex = 0 
)
inline

CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
createRelationshipRequestThe details of the relationship to create.
operationIndexIndex associated with the operation.
Returns
CompleteRelationship

Implements Lusid.Sdk.Api.IRelationshipsApiSync.

◆ CreateRelationshipAsync()

async System.Threading.Tasks.Task<CompleteRelationship> Lusid.Sdk.Api.RelationshipsApi.CreateRelationshipAsync ( string  scope,
string  code,
CreateRelationshipRequest  createRelationshipRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
createRelationshipRequestThe details of the relationship to create.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CompleteRelationship

Implements Lusid.Sdk.Api.IRelationshipsApiAsync.

◆ CreateRelationshipWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CompleteRelationship> Lusid.Sdk.Api.RelationshipsApi.CreateRelationshipWithHttpInfo ( string  scope,
string  code,
CreateRelationshipRequest  createRelationshipRequest,
int  operationIndex = 0 
)
inline

CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
createRelationshipRequestThe details of the relationship to create.
operationIndexIndex associated with the operation.
Returns
ApiResponse of CompleteRelationship

Implements Lusid.Sdk.Api.IRelationshipsApiSync.

◆ CreateRelationshipWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CompleteRelationship> > Lusid.Sdk.Api.RelationshipsApi.CreateRelationshipWithHttpInfoAsync ( string  scope,
string  code,
CreateRelationshipRequest  createRelationshipRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
createRelationshipRequestThe details of the relationship to create.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CompleteRelationship)

Implements Lusid.Sdk.Api.IRelationshipsApiAsync.

◆ DeleteRelationship()

DeletedEntityResponse Lusid.Sdk.Api.RelationshipsApi.DeleteRelationship ( string  scope,
string  code,
DeleteRelationshipRequest  deleteRelationshipRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
deleteRelationshipRequestThe details of the relationship to delete.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationshipsApiSync.

◆ DeleteRelationshipAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.RelationshipsApi.DeleteRelationshipAsync ( string  scope,
string  code,
DeleteRelationshipRequest  deleteRelationshipRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
deleteRelationshipRequestThe details of the relationship to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationshipsApiAsync.

◆ DeleteRelationshipWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.RelationshipsApi.DeleteRelationshipWithHttpInfo ( string  scope,
string  code,
DeleteRelationshipRequest  deleteRelationshipRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
deleteRelationshipRequestThe details of the relationship to delete.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationshipsApiSync.

◆ DeleteRelationshipWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.RelationshipsApi.DeleteRelationshipWithHttpInfoAsync ( string  scope,
string  code,
DeleteRelationshipRequest  deleteRelationshipRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the relationship
codeThe code of the relationship
deleteRelationshipRequestThe details of the relationship to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IRelationshipsApiAsync.

◆ GetBasePath()

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

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

Property Documentation

◆ AsynchronousClient

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

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.RelationshipsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

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

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.RelationshipsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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