Provides a default implementation of an Api client (both synchronous and asynchronous implementations), 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, Func< RestClientOptions, HttpMessageHandler >? CreateHttpMessageHandler=null, bool disposeHandler=true, Func< RestClientOptions, IReadableConfiguration, IRestClientWrapper > createRestClientFunc=null)
	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...

Static Public Member Functions
static ? Policy< RestResponse >	GetSyncPolicy (RequestOptions options)
	Returns the policy configured for executing synchronous requests More...

static ? AsyncPolicy< RestResponse >	GetAsyncPolicy (RequestOptions options)
	Returns the policy configured for executing asynchronous requests More...

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

Detailed Description

Provides a default implementation of an Api client (both synchronous and asynchronous implementations), 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,
		Func< RestClientOptions, HttpMessageHandler >?	CreateHttpMessageHandler = `null`,
		bool	disposeHandler = `true`,
		Func< RestClientOptions, IReadableConfiguration, IRestClientWrapper >	createRestClientFunc = `null`
	)

inline

Initializes a new instance of the ApiClient

Parameters

basePath	The target service's base path in URL format.
CreateHttpMessageHandler	A function to create a HttpMessageHandler for each REST request
disposeHandler	Should the HttpMessageHandler be disposed of after each request
createRestClientFunc	A function that given configuration will return an implementation of the IRestClientWrapper interface. Use to override the default RestClient

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

Implements Lusid.Sdk.Client.ISynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.IAsynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.ISynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.IAsynchronousClient.

◆ GetAsyncPolicy()

static ? AsyncPolicy<RestResponse> Lusid.Sdk.Client.ApiClient.GetAsyncPolicy ( RequestOptions options )

inlinestatic

Returns the policy configured for executing asynchronous requests

Parameters

options

Returns

◆ GetSyncPolicy()

static ? Policy<RestResponse> Lusid.Sdk.Client.ApiClient.GetSyncPolicy ( RequestOptions options )

inlinestatic

Returns the policy configured for executing synchronous requests

Parameters

options

Returns

◆ 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

Implements Lusid.Sdk.Client.ISynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.IAsynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.ISynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.IAsynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.ISynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.IAsynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.ISynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.IAsynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.ISynchronousClient.

◆ 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

Implements Lusid.Sdk.Client.IAsynchronousClient.

Property Documentation

◆ SerializerSettings

JsonSerializerSettings Lusid.Sdk.Client.ApiClient.SerializerSettings

getset

Initial value:

= new JsonSerializerSettings
        {
            
            ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor,
            ContractResolver = new DefaultContractResolver
            {
                NamingStrategy = new CamelCaseNamingStrategy
                {
                    OverrideSpecifiedNames = false
                }
            },
            DateTimeZoneHandling = DateTimeZoneHandling.Utc
        }

Specifies the settings on a JsonSerializer object. These settings can be adjusted to accommodate 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/latest/sdk/Lusid.Sdk/Client/ApiClient.cs

Public Member Functions

Static 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 >()

◆ GetAsyncPolicy()

◆ GetSyncPolicy()

◆ Head< T >()

◆ HeadAsync< T >()

◆ Options< T >()

◆ OptionsAsync< T >()

◆ Patch< T >()

◆ PatchAsync< T >()

◆ Post< T >()

◆ PostAsync< T >()

◆ Put< T >()

◆ PutAsync< T >()

Property Documentation

◆ SerializerSettings