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

Inheritance diagram for Lusid.Sdk.Api.ScopesApi:

[legend]

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

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

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

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

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

ResourceListOfScopeDefinition	ListEntityScopes (string entityType, int operationIndex=0)
	ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition >	ListEntityScopesWithHttpInfo (string entityType, int operationIndex=0)
	ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data. More...

async System.Threading.Tasks.Task< ResourceListOfScopeDefinition >	ListEntityScopesAsync (string entityType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition > >	ListEntityScopesWithHttpInfoAsync (string entityType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data. More...

ResourceListOfScopeDefinition	ListScopes (string? filter=default(string?), int operationIndex=0)
	ListScopes: List Scopes List all the scopes that contain data. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition >	ListScopesWithHttpInfo (string? filter=default(string?), int operationIndex=0)
	ListScopes: List Scopes List all the scopes that contain data. More...

async System.Threading.Tasks.Task< ResourceListOfScopeDefinition >	ListScopesAsync (string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListScopes: List Scopes List all the scopes that contain data. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition > >	ListScopesWithHttpInfoAsync (string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListScopes: List Scopes List all the scopes that contain data. 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

◆ ScopesApi() [1/4]

Lusid.Sdk.Api.ScopesApi.ScopesApi ( )

inline

Initializes a new instance of the ScopesApi class.

Returns

◆ ScopesApi() [2/4]

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

inline

Initializes a new instance of the ScopesApi class.

Returns

◆ ScopesApi() [3/4]

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

inline

Initializes a new instance of the ScopesApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ ScopesApi() [4/4]

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

inline

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

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ ListEntityScopes()

ResourceListOfScopeDefinition Lusid.Sdk.Api.ScopesApi.ListEntityScopes	(	string	entityType,
		int	operationIndex = `0`
	)

inline

ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data.

Exceptions

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

Parameters

entityType	The entity type to list scopes for.
operationIndex	Index associated with the operation.

Returns: ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IScopesApiSync.

◆ ListEntityScopesAsync()

async System.Threading.Tasks.Task<ResourceListOfScopeDefinition> Lusid.Sdk.Api.ScopesApi.ListEntityScopesAsync	(	string	entityType,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data.

Exceptions

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

Parameters

entityType	The entity type to list scopes for.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IScopesApiAsync.

◆ ListEntityScopesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> Lusid.Sdk.Api.ScopesApi.ListEntityScopesWithHttpInfo	(	string	entityType,
		int	operationIndex = `0`
	)

inline

ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data.

Exceptions

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

Parameters

entityType	The entity type to list scopes for.
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IScopesApiSync.

◆ ListEntityScopesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> > Lusid.Sdk.Api.ScopesApi.ListEntityScopesWithHttpInfoAsync	(	string	entityType,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data.

Exceptions

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

Parameters

entityType	The entity type to list scopes for.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfScopeDefinition)

Implements Lusid.Sdk.Api.IScopesApiAsync.

◆ ListScopes()

ResourceListOfScopeDefinition Lusid.Sdk.Api.ScopesApi.ListScopes	(	string?	filter = `default(string?)`,
		int	operationIndex = `0`
	)

inline

ListScopes: List Scopes List all the scopes that contain data.

Exceptions

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

Parameters

filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IScopesApiSync.

◆ ListScopesAsync()

async System.Threading.Tasks.Task<ResourceListOfScopeDefinition> Lusid.Sdk.Api.ScopesApi.ListScopesAsync	(	string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

ListScopes: List Scopes List all the scopes that contain data.

Exceptions

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

Parameters

filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IScopesApiAsync.

◆ ListScopesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> Lusid.Sdk.Api.ScopesApi.ListScopesWithHttpInfo	(	string?	filter = `default(string?)`,
		int	operationIndex = `0`
	)

inline

ListScopes: List Scopes List all the scopes that contain data.

Exceptions

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

Parameters

filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfScopeDefinition

Implements Lusid.Sdk.Api.IScopesApiSync.

◆ ListScopesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> > Lusid.Sdk.Api.ScopesApi.ListScopesWithHttpInfoAsync	(	string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

ListScopes: List Scopes List all the scopes that contain data.

Exceptions

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

Parameters

filter	Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfScopeDefinition)

Implements Lusid.Sdk.Api.IScopesApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.ScopesApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.ScopesApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.ScopesApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ScopesApi() [1/4]

◆ ScopesApi() [2/4]

◆ ScopesApi() [3/4]

◆ ScopesApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ ListEntityScopes()

◆ ListEntityScopesAsync()

◆ ListEntityScopesWithHttpInfo()

◆ ListEntityScopesWithHttpInfoAsync()

◆ ListScopes()

◆ ListScopesAsync()

◆ ListScopesWithHttpInfo()

◆ ListScopesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory