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

Inheritance diagram for Lusid.Sdk.Api.RelationshipsApi:

[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, ConfigurationOptions? opts=null)
	CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers More...

Lusid.Sdk.Client.ApiResponse< CompleteRelationship >	CreateRelationshipWithHttpInfo (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	CreateRelationship: Create Relationship Create a relationship between two entity objects by their identifiers More...

async System.Threading.Tasks.Task< CompleteRelationship >	CreateRelationshipAsync (string scope, string code, CreateRelationshipRequest createRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	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), ConfigurationOptions? opts=null)
	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, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteRelationshipWithHttpInfo (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteRelationship: Delete Relationship Delete a relationship between two entity objects represented by their identifiers More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteRelationshipAsync (string scope, string code, DeleteRelationshipRequest deleteRelationshipRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[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), ConfigurationOptions? opts=null)
	[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...

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

configuration An 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

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ CreateRelationship()

CompleteRelationship Lusid.Sdk.Api.RelationshipsApi.CreateRelationship	(	string	scope,
		string	code,
		CreateRelationshipRequest	createRelationshipRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

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

Parameters

scope	The scope of the relationship
code	The code of the relationship
createRelationshipRequest	The details of the relationship to create.
operationIndex	Index associated with the operation.
opts	Options for this request.

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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

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

Parameters

scope	The scope of the relationship
code	The code of the relationship
createRelationshipRequest	The details of the relationship to create.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this 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`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

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

Parameters

scope	The scope of the relationship
code	The code of the relationship
createRelationshipRequest	The details of the relationship to create.
operationIndex	Index associated with the operation.
opts	Options for this request.

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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

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

Parameters

scope	The scope of the relationship
code	The code of the relationship
createRelationshipRequest	The details of the relationship to create.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this 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`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

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

Parameters

scope	The scope of the relationship
code	The code of the relationship
deleteRelationshipRequest	The details of the relationship to delete.
operationIndex	Index associated with the operation.
opts	Options for this request.

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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

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

Parameters

scope	The scope of the relationship
code	The code of the relationship
deleteRelationshipRequest	The details of the relationship to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this 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`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

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

Parameters

scope	The scope of the relationship
code	The code of the relationship
deleteRelationshipRequest	The details of the relationship to delete.
operationIndex	Index associated with the operation.
opts	Options for this request.

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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

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

Parameters

scope	The scope of the relationship
code	The code of the relationship
deleteRelationshipRequest	The details of the relationship to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this 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

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:

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RelationshipsApi() [1/4]

◆ RelationshipsApi() [2/4]

◆ RelationshipsApi() [3/4]

◆ RelationshipsApi() [4/4]

Member Function Documentation

◆ CreateRelationship()

◆ CreateRelationshipAsync()

◆ CreateRelationshipWithHttpInfo()

◆ CreateRelationshipWithHttpInfoAsync()

◆ DeleteRelationship()

◆ DeleteRelationshipAsync()

◆ DeleteRelationshipWithHttpInfo()

◆ DeleteRelationshipWithHttpInfoAsync()

◆ GetBasePath()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory