flatland.integrations.interactiveai.event_api.configuration module

Contents

flatland.integrations.interactiveai.event_api.configuration module#

APIFlask

No description provided (generated by Openapi Generator openapitools/openapi-generator)

The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class flatland.integrations.interactiveai.event_api.configuration.APIKeyAuthSetting#

Bases: dict

in: str#
key: str#
type: Literal['api_key']#
value: str | None#
class flatland.integrations.interactiveai.event_api.configuration.AuthSettings#

Bases: dict

class flatland.integrations.interactiveai.event_api.configuration.BasicAuthSetting#

Bases: dict

in: Literal['header']#
key: Literal['Authorization']#
type: Literal['basic']#
value: str | None#
class flatland.integrations.interactiveai.event_api.configuration.BearerAuthSetting#

Bases: dict

in: Literal['header']#
key: Literal['Authorization']#
type: Literal['bearer']#
value: str#
class flatland.integrations.interactiveai.event_api.configuration.BearerFormatAuthSetting#

Bases: dict

format: Literal['JWT']#
in: Literal['header']#
key: Literal['Authorization']#
type: Literal['bearer']#
value: str#
class flatland.integrations.interactiveai.event_api.configuration.Configuration(host: str | None = None, api_key: Dict[str, str] | None = None, api_key_prefix: Dict[str, str] | None = None, username: str | None = None, password: str | None = None, access_token: str | None = None, server_index: int | None = None, server_variables: Dict[str, str] | None = None, server_operation_index: Dict[int, int] | None = None, server_operation_variables: Dict[int, Dict[str, str]] | None = None, ignore_operation_servers: bool = False, ssl_ca_cert: str | None = None, retries: int | None = None, *, debug: bool | None = None)[source]#

Bases: object

This class contains various settings of the API client.

Parameters:

host – Base url.

:param ignore_operation_servers

Boolean to ignore operation servers for the API client. Config will use host as the base url regardless of the operation servers.

Parameters:

  • api_key – Dict to store API key(s). Each entry in the dict specifies an API key. The dict key is the name of the security scheme in the OAS specification. The dict value is the API key secret.

  • api_key_prefix – Dict to store API prefix (e.g. Bearer). The dict key is the name of the security scheme in the OAS specification. The dict value is an API key prefix when generating the auth data.

  • username – Username for HTTP basic authentication.

  • password – Password for HTTP basic authentication.

  • access_token – Access token.

  • server_index – Index to servers configuration.

  • server_variables – Mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before.

  • server_operation_index – Mapping from operation ID to an index to server configuration.

  • server_operation_variables – Mapping from operation ID to a mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before.

  • ssl_ca_cert – str - the path to a file of concatenated CA certificates in PEM format.

  • retries – Number of retries for API requests.

access_token#

Access token

assert_hostname#

Set this to True/False to enable/disable SSL hostname verification.

auth_settings() → AuthSettings[source]#

Gets Auth Settings dict for api client.

Returns:

The Auth Settings information dict.

cert_file#

client certificate file

connection_pool_maxsize#

urllib3 connection pool’s maximum number of connections saved per pool. urllib3 uses 1 connection as default value, but this is not the best value when you are making a lot of possibly parallel requests to the same host, which is often the case here. cpu_count * 5 is used as default value to increase performance.

date_format#

date format

datetime_format#

datetime format

property debug: bool#

Debug status

Parameters:

value – The debug status, True or False.

Type:

bool

get_api_key_with_prefix(identifier: str, alias: str | None = None) → str | None[source]#

Gets API key (with prefix if set).

Parameters:

  • identifier – The identifier of apiKey.

  • alias – The alternative identifier of apiKey.

Returns:

The token for api key authentication.

get_basic_auth_token() → str | None[source]#

Gets HTTP basic authentication header (string).

Returns:

The token for basic HTTP authentication.

classmethod get_default() → Self[source]#

Return the default configuration.

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

Returns:

The configuration object.

classmethod get_default_copy() → Self[source]#

Deprecated. Please use get_default instead.

Deprecated. Please use get_default instead.

Returns:

The configuration object.

get_host_from_settings(index: int | None, variables: Dict[str, str] | None = None, servers: List[HostSetting] | None = None) → str[source]#

Gets host URL based on the index and variables :param index: array index of the host settings :param variables: hash of variable and the corresponding value :param servers: an array of host settings or None :return: URL based on host settings

get_host_settings() → List[HostSetting][source]#

Gets an array of host settings

Returns:

An array of host settings

property host: str#

Return generated host.

ignore_operation_servers#

Ignore operation servers

key_file#

client key file

logger#

Logging Settings

property logger_file: str | None#

Debug file location

logger_file_handler: FileHandler | None#

Log file handler

property logger_format: str#

Log format

logger_stream_handler#

Log stream handler

password#

Password for HTTP basic authentication

proxy: str | None#

Proxy URL

proxy_headers#

Proxy headers

refresh_api_key_hook#

function hook to refresh API key if expired

retries#

Adding retries to override urllib3 default value 3

safe_chars_for_path_param#

Safe chars for path_param

server_operation_index#

Default server index

server_operation_variables#

Default server variables

classmethod set_default(default: Self | None) → None[source]#

Set default instance of configuration.

It stores default configuration, which can be returned by get_default_copy method.

Parameters:

default – object of Configuration

socket_options#

Options to pass down to the underlying urllib3 socket

ssl_ca_cert#

Set this to customize the certificate file to verify the peer.

temp_folder_path#

Temp file folder for downloading files

tls_server_name#

SSL/TLS Server Name Indication (SNI) Set this to the SNI value expected by the server.

to_debug_report() → str[source]#

Gets the essential information for debugging.

Returns:

The report for debugging.

username#

Username for HTTP basic authentication

verify_ssl#

SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.

class flatland.integrations.interactiveai.event_api.configuration.GenericAuthSetting#

Bases: dict

in: str#
key: str#
type: str#
value: str#
class flatland.integrations.interactiveai.event_api.configuration.HTTPSignatureAuthSetting#

Bases: dict

in: Literal['header']#
key: Literal['Authorization']#
type: Literal['http-signature']#
value: None#
class flatland.integrations.interactiveai.event_api.configuration.HostSetting[source]#

Bases: TypedDict

description: str#
url: str#
variables: NotRequired[Dict[str, HostSettingVariable]]#
class flatland.integrations.interactiveai.event_api.configuration.HostSettingVariable[source]#

Bases: TypedDict

default_value: str#
description: str#
enum_values: List[str]#
class flatland.integrations.interactiveai.event_api.configuration.OAuth2AuthSetting#

Bases: dict

in: Literal['header']#
key: Literal['Authorization']#
type: Literal['oauth2']#
value: str#
Contents