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

Inheritance diagram for Lusid.Sdk.Api.RelationsApi:

[legend]

Public Member Functions
	RelationsApi ()
	Initializes a new instance of the RelationsApi class. More...

	RelationsApi (string basePath)
	Initializes a new instance of the RelationsApi class. More...

	RelationsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the RelationsApi class using Configuration object More...

	RelationsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the RelationsApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

CompleteRelation	CreateRelation (string scope, string code, CreateRelationRequest createRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateRelation: Create Relation Create a relation between two entity objects by their identifiers More...

Lusid.Sdk.Client.ApiResponse< CompleteRelation >	CreateRelationWithHttpInfo (string scope, string code, CreateRelationRequest createRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateRelation: Create Relation Create a relation between two entity objects by their identifiers More...

async System.Threading.Tasks.Task< CompleteRelation >	CreateRelationAsync (string scope, string code, CreateRelationRequest createRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateRelation: Create Relation Create a relation between two entity objects by their identifiers More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CompleteRelation > >	CreateRelationWithHttpInfoAsync (string scope, string code, CreateRelationRequest createRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateRelation: Create Relation Create a relation between two entity objects by their identifiers More...

DeletedEntityResponse	DeleteRelation (string scope, string code, DeleteRelationRequest deleteRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteRelation: Delete a relation Delete a relation between two entity objects represented by their identifiers More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteRelationWithHttpInfo (string scope, string code, DeleteRelationRequest deleteRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteRelation: Delete a relation Delete a relation between two entity objects represented by their identifiers More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteRelationAsync (string scope, string code, DeleteRelationRequest deleteRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteRelation: Delete a relation Delete a relation between two entity objects represented by their identifiers More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteRelationWithHttpInfoAsync (string scope, string code, DeleteRelationRequest deleteRelationRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteRelation: Delete a relation Delete a relation 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

◆ RelationsApi() [1/4]

Lusid.Sdk.Api.RelationsApi.RelationsApi ( )

inline

Initializes a new instance of the RelationsApi class.

Returns

◆ RelationsApi() [2/4]

Lusid.Sdk.Api.RelationsApi.RelationsApi ( string basePath )

inline

Initializes a new instance of the RelationsApi class.

Returns

◆ RelationsApi() [3/4]

Lusid.Sdk.Api.RelationsApi.RelationsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the RelationsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ RelationsApi() [4/4]

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

inline

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

◆ CreateRelation()

CompleteRelation Lusid.Sdk.Api.RelationsApi.CreateRelation	(	string	scope,
		string	code,
		CreateRelationRequest	createRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateRelation: Create Relation Create a relation 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 relation definition
code	The code of the relation definition
createRelationRequest	The details of the relation to create.
effectiveAt	The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CompleteRelation

Implements Lusid.Sdk.Api.IRelationsApiSync.

◆ CreateRelationAsync()

async System.Threading.Tasks.Task<CompleteRelation> Lusid.Sdk.Api.RelationsApi.CreateRelationAsync	(	string	scope,
		string	code,
		CreateRelationRequest	createRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateRelation: Create Relation Create a relation 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 relation definition
code	The code of the relation definition
createRelationRequest	The details of the relation to create.
effectiveAt	The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CompleteRelation

Implements Lusid.Sdk.Api.IRelationsApiAsync.

◆ CreateRelationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CompleteRelation> Lusid.Sdk.Api.RelationsApi.CreateRelationWithHttpInfo	(	string	scope,
		string	code,
		CreateRelationRequest	createRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateRelation: Create Relation Create a relation 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 relation definition
code	The code of the relation definition
createRelationRequest	The details of the relation to create.
effectiveAt	The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CompleteRelation

Implements Lusid.Sdk.Api.IRelationsApiSync.

◆ CreateRelationWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CompleteRelation> > Lusid.Sdk.Api.RelationsApi.CreateRelationWithHttpInfoAsync	(	string	scope,
		string	code,
		CreateRelationRequest	createRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateRelation: Create Relation Create a relation 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 relation definition
code	The code of the relation definition
createRelationRequest	The details of the relation to create.
effectiveAt	The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CompleteRelation)

Implements Lusid.Sdk.Api.IRelationsApiAsync.

◆ DeleteRelation()

DeletedEntityResponse Lusid.Sdk.Api.RelationsApi.DeleteRelation	(	string	scope,
		string	code,
		DeleteRelationRequest	deleteRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteRelation: Delete a relation Delete a relation 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 relation definition
code	The code of the relation definition
deleteRelationRequest	The details of the relation to delete.
effectiveAt	The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationsApiSync.

◆ DeleteRelationAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.RelationsApi.DeleteRelationAsync	(	string	scope,
		string	code,
		DeleteRelationRequest	deleteRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteRelation: Delete a relation Delete a relation 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 relation definition
code	The code of the relation definition
deleteRelationRequest	The details of the relation to delete.
effectiveAt	The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
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.IRelationsApiAsync.

◆ DeleteRelationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.RelationsApi.DeleteRelationWithHttpInfo	(	string	scope,
		string	code,
		DeleteRelationRequest	deleteRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteRelation: Delete a relation Delete a relation 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 relation definition
code	The code of the relation definition
deleteRelationRequest	The details of the relation to delete.
effectiveAt	The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationsApiSync.

◆ DeleteRelationWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.RelationsApi.DeleteRelationWithHttpInfoAsync	(	string	scope,
		string	code,
		DeleteRelationRequest	deleteRelationRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteRelation: Delete a relation Delete a relation 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 relation definition
code	The code of the relation definition
deleteRelationRequest	The details of the relation to delete.
effectiveAt	The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime if not specified. (optional)
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.IRelationsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.RelationsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.RelationsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.RelationsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.RelationsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.RelationsApi.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/RelationsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RelationsApi() [1/4]

◆ RelationsApi() [2/4]

◆ RelationsApi() [3/4]

◆ RelationsApi() [4/4]

Member Function Documentation

◆ CreateRelation()

◆ CreateRelationAsync()

◆ CreateRelationWithHttpInfo()

◆ CreateRelationWithHttpInfoAsync()

◆ DeleteRelation()

◆ DeleteRelationAsync()

◆ DeleteRelationWithHttpInfo()

◆ DeleteRelationWithHttpInfoAsync()

◆ GetBasePath()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory