rebrickable.api.configuration module¶

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

class rebrickable.api.configuration.Configuration(**kwargs)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator

Ref: https://openapi-generator.tech Do not edit the class manually.

Parameters

host – Base url
api_key – Dict to store API key(s)
api_key_prefix – Dict to store API prefix (e.g. Bearer)
username – Username for HTTP basic authentication
password – Password for HTTP basic authentication

api_key¶: dict to store API key(s)

api_key_prefix¶: dict to store API prefix (e.g. Bearer)

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

auth_settings()¶

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.

property debug¶: Debug switch

get_api_key_with_prefix(identifier)¶

Gets API key (with prefix if set).

Parameters: identifier – The identifier of apiKey.
Returns: The token for api key authentication.

get_basic_auth_token()¶

Gets HTTP basic authentication header (string).

Returns: The token for basic HTTP authentication.

get_host_from_settings(index, variables={})¶: 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 :return: URL based on host settings

get_host_settings()¶

Gets an array of host settings

Returns: An array of host settings

host¶: Default Base url

key_file¶: client key file

logger¶: Logging Settings

property logger_file¶: Debug file location

logger_file_handler¶: Log file handler

property logger_format¶: Log format

logger_stream_handler¶: Log stream handler

password¶: Password for HTTP basic authentication

proxy¶: 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

ssl_ca_cert¶: Set this to customize the certificate file to verify the peer.

temp_folder_path¶: Temp file folder for downloading files

to_debug_report()¶

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 rebrickable.api.configuration.TypeWithDefault(name, bases, dct)¶

Bases: type

set_default(default)¶