LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Client.ISynchronousClient Interface Reference

Contract for Synchronous RESTful API interactions. More...

Inheritance diagram for Lusid.Sdk.Client.ISynchronousClient:
Inheritance graph
[legend]

Public Member Functions

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...
 

Detailed Description

Contract for Synchronous RESTful API interactions.

This interface allows consumers to provide a custom API accessor client.

Member Function Documentation

◆ Delete< T >()

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

Executes a blocking call to some path using the DELETE http verb.

Parameters
pathThe relative path to invoke.
optionsThe request parameters to pass along to the client.
configurationPer-request configurable settings.
Template Parameters
TThe return type.
Returns
The response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

◆ Get< T >()

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

Executes a blocking call to some path using the GET http verb.

Parameters
pathThe relative path to invoke.
optionsThe request parameters to pass along to the client.
configurationPer-request configurable settings.
Template Parameters
TThe return type.
Returns
The response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

◆ Head< T >()

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

Executes a blocking call to some path using the HEAD http verb.

Parameters
pathThe relative path to invoke.
optionsThe request parameters to pass along to the client.
configurationPer-request configurable settings.
Template Parameters
TThe return type.
Returns
The response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

◆ Options< T >()

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

Executes a blocking call to some path using the OPTIONS http verb.

Parameters
pathThe relative path to invoke.
optionsThe request parameters to pass along to the client.
configurationPer-request configurable settings.
Template Parameters
TThe return type.
Returns
The response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

◆ Patch< T >()

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

Executes a blocking call to some path using the PATCH http verb.

Parameters
pathThe relative path to invoke.
optionsThe request parameters to pass along to the client.
configurationPer-request configurable settings.
Template Parameters
TThe return type.
Returns
The response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

◆ Post< T >()

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

Executes a blocking call to some path using the POST http verb.

Parameters
pathThe relative path to invoke.
optionsThe request parameters to pass along to the client.
configurationPer-request configurable settings.
Template Parameters
TThe return type.
Returns
The response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

◆ Put< T >()

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

Executes a blocking call to some path using the PUT http verb.

Parameters
pathThe relative path to invoke.
optionsThe request parameters to pass along to the client.
configurationPer-request configurable settings.
Template Parameters
TThe return type.
Returns
The response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.


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