Module livechat.billing.base

Module with base class that allows retrieval of client for specific Billing API version.

''' Module with base class that allows retrieval of client for specific
    Billing API version. '''

# pylint: disable=W0613,W0622,C0103,R0913,R0903

from __future__ import annotations

import httpx

from livechat.config import CONFIG

from .api import BillingApiV1

billing_url = CONFIG.get('billing_url')
billing_version = CONFIG.get('billing_version')


class BillingApi:
    ''' Base class that allows retrieval of client for specific
        Billing API version. '''
    @staticmethod
    def get_client(
        token: str,
        version: str = billing_version,
        base_url: str = billing_url,
        http2: bool = False,
        proxies: dict = None,
        verify: bool = True,
        disable_logging: bool = False,
        timeout: float = httpx.Timeout(15)
    ) -> BillingApiV1:
        ''' Returns client for specific Billing API version.

            Args:
                token (str): Full token with type Bearer that will be
                    used as `Authorization` header in requests to API.
                version (str): Billing API's version. Defaults to the v1 version of Billing.
                base_url (str): API's base url. Defaults to API's production URL.
                http2 (bool): A boolean indicating if HTTP/2 support should be
                              enabled. Defaults to `False`.
                proxies (dict): A dictionary mapping proxy keys to proxy URLs.
                verify (bool): SSL certificates (a.k.a CA bundle) used to
                               verify the identity of requested hosts. Either `True` (default CA bundle),
                               a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                               (which will disable verification). Defaults to `True`.
                disable_logging (bool): indicates if logging should be disabled.
                timeout (float): The timeout configuration to use when sending requests.
                                 Defaults to 15 seconds.

            Returns:
                BillingApi: API client object for specified version.

            Raises:
                ValueError: If the specified version does not exist.
        '''
        client = {
            '1':
            BillingApiV1(token, base_url, http2, proxies, verify,
                         disable_logging, timeout),
        }.get(version)
        if not client:
            raise ValueError('Provided version does not exist.')
        return client

Classes

class BillingApi

Base class that allows retrieval of client for specific Billing API version.

Expand source code

class BillingApi:
    ''' Base class that allows retrieval of client for specific
        Billing API version. '''
    @staticmethod
    def get_client(
        token: str,
        version: str = billing_version,
        base_url: str = billing_url,
        http2: bool = False,
        proxies: dict = None,
        verify: bool = True,
        disable_logging: bool = False,
        timeout: float = httpx.Timeout(15)
    ) -> BillingApiV1:
        ''' Returns client for specific Billing API version.

            Args:
                token (str): Full token with type Bearer that will be
                    used as `Authorization` header in requests to API.
                version (str): Billing API's version. Defaults to the v1 version of Billing.
                base_url (str): API's base url. Defaults to API's production URL.
                http2 (bool): A boolean indicating if HTTP/2 support should be
                              enabled. Defaults to `False`.
                proxies (dict): A dictionary mapping proxy keys to proxy URLs.
                verify (bool): SSL certificates (a.k.a CA bundle) used to
                               verify the identity of requested hosts. Either `True` (default CA bundle),
                               a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                               (which will disable verification). Defaults to `True`.
                disable_logging (bool): indicates if logging should be disabled.
                timeout (float): The timeout configuration to use when sending requests.
                                 Defaults to 15 seconds.

            Returns:
                BillingApi: API client object for specified version.

            Raises:
                ValueError: If the specified version does not exist.
        '''
        client = {
            '1':
            BillingApiV1(token, base_url, http2, proxies, verify,
                         disable_logging, timeout),
        }.get(version)
        if not client:
            raise ValueError('Provided version does not exist.')
        return client

Static methods

def get_client(token: str, version: str = '1', base_url: str = 'billing.livechatinc.com', http2: bool = False, proxies: dict = None, verify: bool = True, disable_logging: bool = False, timeout: float = Timeout(timeout=15)) ‑> BillingApiV1

Returns client for specific Billing API version.

Args

token : str

Full token with type Bearer that will be used as Authorization header in requests to API.

version : str

Billing API's version. Defaults to the v1 version of Billing.

base_url : str

API's base url. Defaults to API's production URL.

http2 : bool

A boolean indicating if HTTP/2 support should be enabled. Defaults to False.

proxies : dict

A dictionary mapping proxy keys to proxy URLs.

verify : bool

SSL certificates (a.k.a CA bundle) used to verify the identity of requested hosts. Either True (default CA bundle), a path to an SSL certificate file, an ssl.SSLContext, or False (which will disable verification). Defaults to True.

disable_logging : bool

indicates if logging should be disabled.

timeout : float

The timeout configuration to use when sending requests. Defaults to 15 seconds.

Returns

BillingApi

API client object for specified version.

Raises

ValueError

If the specified version does not exist.

Expand source code

@staticmethod
def get_client(
    token: str,
    version: str = billing_version,
    base_url: str = billing_url,
    http2: bool = False,
    proxies: dict = None,
    verify: bool = True,
    disable_logging: bool = False,
    timeout: float = httpx.Timeout(15)
) -> BillingApiV1:
    ''' Returns client for specific Billing API version.

        Args:
            token (str): Full token with type Bearer that will be
                used as `Authorization` header in requests to API.
            version (str): Billing API's version. Defaults to the v1 version of Billing.
            base_url (str): API's base url. Defaults to API's production URL.
            http2 (bool): A boolean indicating if HTTP/2 support should be
                          enabled. Defaults to `False`.
            proxies (dict): A dictionary mapping proxy keys to proxy URLs.
            verify (bool): SSL certificates (a.k.a CA bundle) used to
                           verify the identity of requested hosts. Either `True` (default CA bundle),
                           a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                           (which will disable verification). Defaults to `True`.
            disable_logging (bool): indicates if logging should be disabled.
            timeout (float): The timeout configuration to use when sending requests.
                             Defaults to 15 seconds.

        Returns:
            BillingApi: API client object for specified version.

        Raises:
            ValueError: If the specified version does not exist.
    '''
    client = {
        '1':
        BillingApiV1(token, base_url, http2, proxies, verify,
                     disable_logging, timeout),
    }.get(version)
    if not client:
        raise ValueError('Provided version does not exist.')
    return client