symphony.bdk.core.client.api_client_factory.ApiClientFactory

class symphony.bdk.core.client.api_client_factory.ApiClientFactory(config)

Bases: object

Factory responsible for creating ApiClient instances for each main Symphony’s components.

__init__(config)

Methods

__init__(config)
close_clients()	Close all the existing api clients created by the api client factory.
get_agent_client()	Returns a fully initialized ApiClient for Agent API.
get_app_session_auth_client()	Returns a fully initialized ApiClient for Session Auth API for certificate OBO authentication.
get_client(context_path)	Returns a fully initialized custom ApiClient
get_key_auth_client()	Returns a fully initialized ApiClient for Key Auth Api for bot certificate authentication.
get_login_client()	Returns a fully initialized ApiClient for Login API.
get_pod_client()	Returns a fully initialized ApiClient for Pod API.
get_relay_client()	Returns a fully initialized ApiClient for Key Manager API.
get_session_auth_client()	Returns a fully initialized ApiClient for Session Auth Api for bot certificate authentication.

async close_clients()

Close all the existing api clients created by the api client factory.

get_agent_client() → symphony.bdk.gen.api_client.ApiClient

Returns a fully initialized ApiClient for Agent API.

Returns

an ApiClient instance for Agent API.

get_app_session_auth_client() → symphony.bdk.gen.api_client.ApiClient

Returns a fully initialized ApiClient for Session Auth API for certificate OBO authentication.

Returns

an ApiClient instance for Session Auth API.

get_client(context_path)

Returns a fully initialized custom ApiClient

Parameters

context_path – custom path to be used in the client

Returns

an ApiClient instance

get_key_auth_client() → symphony.bdk.gen.api_client.ApiClient

Returns a fully initialized ApiClient for Key Auth Api for bot certificate authentication.

Returns

an ApiClient instance for Key Auth Api for bot certificate authentication.

get_login_client() → symphony.bdk.gen.api_client.ApiClient

Returns a fully initialized ApiClient for Login API.

Returns

an ApiClient instance for Login API.

get_pod_client() → symphony.bdk.gen.api_client.ApiClient

Returns a fully initialized ApiClient for Pod API.

Returns

an ApiClient instance for Pod API.

get_relay_client() → symphony.bdk.gen.api_client.ApiClient

Returns a fully initialized ApiClient for Key Manager API.

Returns

an ApiClient instance for Key Manager API.

get_session_auth_client() → symphony.bdk.gen.api_client.ApiClient

Returns a fully initialized ApiClient for Session Auth Api for bot certificate authentication.

Returns

an ApiClient instance for Session Auth Api for bot certificate authentication.