Provides a default implementation of an Api client (both synchronous and asynchronous implementatios), encapsulating general REST accessor use cases. More...

Inheritance diagram for Lusid.Sdk.Client.ApiClient:

[legend]

Public Member Functions
	ApiClient ()
	Initializes a new instance of the ApiClient, defaulting to the global configurations' base url. More...

	ApiClient (String basePath)
	Initializes a new instance of the ApiClient More...

Task< ApiResponse< T > >	GetAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Make a HTTP GET request (async). More...

Task< ApiResponse< T > >	PostAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Make a HTTP POST request (async). More...

Task< ApiResponse< T > >	PutAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Make a HTTP PUT request (async). More...

Task< ApiResponse< T > >	DeleteAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Make a HTTP DELETE request (async). More...

Task< ApiResponse< T > >	HeadAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Make a HTTP HEAD request (async). More...

Task< ApiResponse< T > >	OptionsAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Make a HTTP OPTION request (async). More...

Task< ApiResponse< T > >	PatchAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Make a HTTP PATCH request (async). More...

ApiResponse< T >	Get< T > (string path, RequestOptions options, IReadableConfiguration configuration=null)
	Make a HTTP GET request (synchronous). More...

ApiResponse< T >	Post< T > (string path, RequestOptions options, IReadableConfiguration configuration=null)
	Make a HTTP POST request (synchronous). More...

ApiResponse< T >	Put< T > (string path, RequestOptions options, IReadableConfiguration configuration=null)
	Make a HTTP PUT request (synchronous). More...

ApiResponse< T >	Delete< T > (string path, RequestOptions options, IReadableConfiguration configuration=null)
	Make a HTTP DELETE request (synchronous). More...

ApiResponse< T >	Head< T > (string path, RequestOptions options, IReadableConfiguration configuration=null)
	Make a HTTP HEAD request (synchronous). More...

ApiResponse< T >	Options< T > (string path, RequestOptions options, IReadableConfiguration configuration=null)
	Make a HTTP OPTION request (synchronous). More...

ApiResponse< T >	Patch< T > (string path, RequestOptions options, IReadableConfiguration configuration=null)
	Make a HTTP PATCH request (synchronous). More...

Public Member Functions inherited from Lusid.Sdk.Client.ISynchronousClient
ApiResponse< T >	Get< T > (String path, RequestOptions options, IReadableConfiguration configuration=null)
	Executes a blocking call to some path using the GET http verb. More...

ApiResponse< T >	Post< T > (String path, RequestOptions options, IReadableConfiguration configuration=null)
	Executes a blocking call to some path using the POST http verb. More...

ApiResponse< T >	Put< T > (String path, RequestOptions options, IReadableConfiguration configuration=null)
	Executes a blocking call to some path using the PUT http verb. More...

ApiResponse< T >	Delete< T > (String path, RequestOptions options, IReadableConfiguration configuration=null)
	Executes a blocking call to some path using the DELETE http verb. More...

ApiResponse< T >	Head< T > (String path, RequestOptions options, IReadableConfiguration configuration=null)
	Executes a blocking call to some path using the HEAD http verb. More...

ApiResponse< T >	Options< T > (String path, RequestOptions options, IReadableConfiguration configuration=null)
	Executes a blocking call to some path using the OPTIONS http verb. More...

ApiResponse< T >	Patch< T > (String path, RequestOptions options, IReadableConfiguration configuration=null)
	Executes a blocking call to some path using the PATCH http verb. More...

Public Member Functions inherited from Lusid.Sdk.Client.IAsynchronousClient
Task< ApiResponse< T > >	GetAsync< T > (String path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the GET http verb. More...

Task< ApiResponse< T > >	PostAsync< T > (String path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the POST http verb. More...

Task< ApiResponse< T > >	PutAsync< T > (String path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the PUT http verb. More...

Task< ApiResponse< T > >	DeleteAsync< T > (String path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the DELETE http verb. More...

Task< ApiResponse< T > >	HeadAsync< T > (String path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the HEAD http verb. More...

Task< ApiResponse< T > >	OptionsAsync< T > (String path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the OPTIONS http verb. More...

Task< ApiResponse< T > >	PatchAsync< T > (String path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the PATCH http verb. More...

Properties
JsonSerializerSettings	SerializerSettings `[get, set]`
	Specifies the settings on a JsonSerializer object. These settings can be adjusted to accomodate custom serialization rules. More...

Detailed Description

Provides a default implementation of an Api client (both synchronous and asynchronous implementatios), encapsulating general REST accessor use cases.

Constructor & Destructor Documentation

◆ ApiClient() [1/2]

Lusid.Sdk.Client.ApiClient.ApiClient ( )

inline

Initializes a new instance of the ApiClient, defaulting to the global configurations' base url.

◆ ApiClient() [2/2]

Lusid.Sdk.Client.ApiClient.ApiClient ( String basePath )

inline

Initializes a new instance of the ApiClient

Parameters

basePath The target service's base path in URL format.

Exceptions

ArgumentException

Member Function Documentation

◆ Delete< T >()

ApiResponse<T> Lusid.Sdk.Client.ApiClient.Delete< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`
	)

inline

Make a HTTP DELETE request (synchronous).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.

Returns: A Task containing ApiResponse

◆ DeleteAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.ApiClient.DeleteAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

Make a HTTP DELETE request (async).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.
cancellationToken	Token that enables callers to cancel the request.

Returns: A Task containing ApiResponse

◆ Get< T >()

ApiResponse<T> Lusid.Sdk.Client.ApiClient.Get< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`
	)

inline

Make a HTTP GET request (synchronous).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.

Returns: A Task containing ApiResponse

◆ GetAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.ApiClient.GetAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

Make a HTTP GET request (async).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.
cancellationToken	Token that enables callers to cancel the request.

Returns: A Task containing ApiResponse

◆ Head< T >()

ApiResponse<T> Lusid.Sdk.Client.ApiClient.Head< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`
	)

inline

Make a HTTP HEAD request (synchronous).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.

Returns: A Task containing ApiResponse

◆ HeadAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.ApiClient.HeadAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

Make a HTTP HEAD request (async).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.
cancellationToken	Token that enables callers to cancel the request.

Returns: A Task containing ApiResponse

◆ Options< T >()

ApiResponse<T> Lusid.Sdk.Client.ApiClient.Options< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`
	)

inline

Make a HTTP OPTION request (synchronous).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.

Returns: A Task containing ApiResponse

◆ OptionsAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.ApiClient.OptionsAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

Make a HTTP OPTION request (async).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.
cancellationToken	Token that enables callers to cancel the request.

Returns: A Task containing ApiResponse

◆ Patch< T >()

ApiResponse<T> Lusid.Sdk.Client.ApiClient.Patch< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`
	)

inline

Make a HTTP PATCH request (synchronous).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.

Returns: A Task containing ApiResponse

◆ PatchAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.ApiClient.PatchAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

Make a HTTP PATCH request (async).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.
cancellationToken	Token that enables callers to cancel the request.

Returns: A Task containing ApiResponse

◆ Post< T >()

ApiResponse<T> Lusid.Sdk.Client.ApiClient.Post< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`
	)

inline

Make a HTTP POST request (synchronous).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.

Returns: A Task containing ApiResponse

◆ PostAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.ApiClient.PostAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

Make a HTTP POST request (async).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.
cancellationToken	Token that enables callers to cancel the request.

Returns: A Task containing ApiResponse

◆ Put< T >()

ApiResponse<T> Lusid.Sdk.Client.ApiClient.Put< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`
	)

inline

Make a HTTP PUT request (synchronous).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.

Returns: A Task containing ApiResponse

◆ PutAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.ApiClient.PutAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = `null`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

Make a HTTP PUT request (async).

Parameters

path	The target path (or resource).
options	The additional request options.
configuration	A per-request configuration object. It is assumed that any merge with GlobalConfiguration has been done before calling this method.
cancellationToken	Token that enables callers to cancel the request.

Returns: A Task containing ApiResponse

Property Documentation

◆ SerializerSettings

JsonSerializerSettings Lusid.Sdk.Client.ApiClient.SerializerSettings

getset

Specifies the settings on a JsonSerializer object. These settings can be adjusted to accomodate custom serialization rules.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/stable/sdk/Lusid.Sdk/Client/ApiClient.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ApiClient() [1/2]

◆ ApiClient() [2/2]

Member Function Documentation

◆ Delete< T >()

◆ DeleteAsync< T >()

◆ Get< T >()

◆ GetAsync< T >()

◆ Head< T >()

◆ HeadAsync< T >()

◆ Options< T >()

◆ OptionsAsync< T >()

◆ Patch< T >()

◆ PatchAsync< T >()

◆ Post< T >()

◆ PostAsync< T >()

◆ Put< T >()

◆ PutAsync< T >()

Property Documentation

◆ SerializerSettings