sdk.lusid.api_client.ApiClient

class ApiClient(configuration=None, header_name=None, header_value=None, cookie=None, pool_threads=1)

Generic API client for OpenAPI client library builds.

OpenAPI generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the OpenAPI templates.

Parameters:

• configuration – .Configuration object for this client

• header_name – a header to pass when making calls to the API.

• header_value – a header value to pass when making calls to the API.

• cookie – a cookie to include in the header when making calls to the API

• pool_threads – The number of threads to use for async requests to the API. More threads means more concurrent API requests.

Attributes

This is a Pydantic class. For now, click on the green [source] link in the class signature above to see descriptions/allowed values for these attributes.

NATIVE_TYPES_MAPPING
PRIMITIVE_TYPES
pool	Create thread pool on first request avoids instantiating unused threadpool for blocking clients.
user_agent	User agent for this API client

Methods

call_api	Makes the HTTP request (synchronous) and returns deserialized data.
close
deserialize	Deserializes response into an object.
files_parameters	Builds form parameters.
get_default	Return new instance of ApiClient.
parameters_to_tuples	Get parameters as list of tuples, formatting collections.
parameters_to_url_query	Get parameters as list of tuples, formatting collections.
request	Makes the HTTP request using RESTClient.
sanitize_for_serialization	Builds a JSON POST object.
select_header_accept	Returns Accept based on an array of accepts provided.
select_header_content_type	Returns Content-Type based on an array of content_types provided.
set_default	Set default instance of ApiClient.
set_default_header
update_params_for_auth	Updates header and query params based on authentication setting.

call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_types_map=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None, _host=None, _request_auth=None)

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async_req request, set the async_req parameter.

Parameters:

• resource_path – Path to method endpoint.

• method – Method to call.

• path_params – Path parameters in the url.

• query_params – Query parameters in the url.

• header_params – Header parameters to be placed in the request header.

• body – Request body.

• dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

• list (auth_settings) – Auth Settings names for the request.

• response – Response data type.

• dict – key -> filename, value -> filepath, for multipart/form-data.

• bool (async_req) – execute request asynchronously

• _return_http_data_only – response data instead of ApiResponse object with status code, headers, etc

• _preload_content – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• collection_formats – dict of collection formats for path, query, header, and post parameters.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.

deserialize(response, response_type)

Deserializes response into an object.

Parameters:

• response – RESTResponse object to be deserialized.

• response_type – class literal for deserialized object, or string of class name.

Returns:

deserialized object.

files_parameters(files=None)

Builds form parameters.

Parameters:

files – File parameters.

Returns:

Form parameters with files.

classmethod get_default()

Return new instance of ApiClient.

This method returns newly created, based on default constructor, object of ApiClient class or returns a copy of default ApiClient.

Returns:

The ApiClient object.

parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters:

• params – Parameters as dict or list of two-tuples

• collection_formats (dict) – Parameter collection formats

Returns:

Parameters as list of tuples, collections formatted

parameters_to_url_query(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters:

• params – Parameters as dict or list of two-tuples

• collection_formats (dict) – Parameter collection formats

Returns:

URL query string (e.g. a=Hello%20World&b=123)

property pool

Create thread pool on first request avoids instantiating unused threadpool for blocking clients.

request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date

convert to string in iso8601 format.

If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is OpenAPI model, return the properties dict.

Parameters:

obj – The data to serialize.

Returns:

The serialized form of data.

select_header_accept(accepts)

Returns Accept based on an array of accepts provided.

Parameters:

accepts – List of headers.

Returns:

Accept (e.g. application/json).

select_header_content_type(content_types)

Returns Content-Type based on an array of content_types provided.

Parameters:

content_types – List of content-types.

Returns:

Content-Type (e.g. application/json).

classmethod set_default(default)

Set default instance of ApiClient.

It stores default ApiClient.

Parameters:

default – object of ApiClient.

update_params_for_auth(headers, queries, auth_settings, resource_path, method, body, request_auth=None)

Updates header and query params based on authentication setting.

Parameters:

• headers – Header parameters dict to be updated.

• queries – Query parameters tuple list to be updated.

• auth_settings – Authentication setting identifiers list.

Resource_path:

A string representation of the HTTP request resource path.

Method:

A string representation of the HTTP request method.

Body:

A object representing the body of the HTTP request.

The object type is the return value of sanitize_for_serialization(). :type request_auth: :param request_auth: if set, the provided settings will

override the token in the configuration.

property user_agent

User agent for this API client