CR fixes

Author: remleinpiotr

changelog.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 ## [0.3.6] - TBA
 
+### Added
+
+- Added support for billing-api.
+
 ### Bugfixes
 - Fix `customer_monitoring_level` parameter in `login` method in agent-api v3.3/v3.4/v3.5 classes.
 

livechat/billing/api/v1.py

@@ -34,8 +34,8 @@ def create_direct_charge(self,
                 price (int): Price of the charge defined in cents.
                 quantity (int): Number of the accounts within the organization.
                 return_url (str): Redirection url for the client.
-                per_account (bool): Whether or not the app is sold in ppa account model.
-                test (str): Whether or not the direct charge is for test.
+                per_account (bool): Whether or not the app is sold in ppa account model. Default: False.
+                test (str): Whether or not the direct charge is for test. Default: False.
                 payload (dict): Custom payload to be used as request's data.
                                 It overrides all other parameters provided for the method.
                 headers (dict): Custom headers to be used with session headers.
@@ -82,7 +82,7 @@ def list_direct_charges(self,
                             headers: dict = None) -> httpx.Response:
         ''' Lists all direct charges.
             Args:
-                page (int): Navigate to page number.
+                page (int): Navigate to page number. Default: 1.
                 status (str): Filter charges by status. One of pending, accepted, active, declined, processed, failed or success.
                 order_client_id (str): Filter by specific `order_client_id`.
                 params (dict): Custom params to be used in request's query string.
@@ -119,17 +119,20 @@ def activate_direct_charge(self,
         if payload is None:
             payload = prepare_payload(locals())
             del payload['charge_id']
-        return self.session.put(f'{self.api_url}/direct_charge/{charge_id}',
-                                json=payload,
-                                headers=headers)
+        return self.session.put(
+            f'{self.api_url}/direct_charge/{charge_id}/activate',
+            json=payload,
+            headers=headers)
 
 # ledger
 
     def get_ledger(self,
+                   page: int = None,
                    params: dict = None,
                    headers: dict = None) -> httpx.Response:
         ''' Returns current ledger.
             Args:
+                page (int): Navigate to page number. Default: 1.
                 params (dict): Custom params to be used in request's query string.
                                 It overrides all other parameters provided for the method.
                 headers (dict): Custom headers to be used with session headers.
@@ -148,7 +151,7 @@ def get_ledger(self,
     def get_ledger_balance(self,
                            params: dict = None,
                            headers: dict = None) -> httpx.Response:
-        ''' Returns current ledger balance.
+        ''' Returns current ledger balance in cents.
             Args:
                 params (dict): Custom params to be used in request's query string.
                                 It overrides all other parameters provided for the method.
@@ -178,15 +181,15 @@ def create_recurrent_charge(self,
                                 test: bool = True,
                                 payload: dict = None,
                                 headers: dict = None) -> httpx.Response:
-        ''' Creates a new reccurent charge for the user (periodic payment).
+        ''' Creates a new recurrent charge for the user (periodic payment).
             Args:
-                name (str): Name of the reccurent charge.
+                name (str): Name of the recurrent charge.
                 price (int): Price of the charge defined in cents.
                 return_url (str): Redirection url for the client.
-                per_account (bool): Whether or not the app is sold in ppa account model.
-                trial_days (int): Number of granted trial days.
-                months (int): Charge frequency expressed in months.
-                test (str): Whether or not the direct charge is for test.
+                per_account (bool): Whether or not the app is sold in ppa account model. Default: False.
+                trial_days (int): Number of granted trial days. Default: 0.
+                months (int): Charge frequency expressed in months. Default: 1.
+                test (str): Whether or not the direct charge is for test. Default: False.
                 payload (dict): Custom payload to be used as request's data.
                                 It overrides all other parameters provided for the method.
                 headers (dict): Custom headers to be used with session headers.
@@ -206,7 +209,7 @@ def get_recurrent_charge(self,
                              charge_id: str,
                              params: dict = None,
                              headers: dict = None) -> httpx.Response:
-        ''' Gets specific reccurent charge.
+        ''' Gets specific recurrent charge.
             Args:
                 charge_id (str): ID of the recurrent charge.
                 params (dict): Custom params to be used in request's query string.
@@ -233,7 +236,7 @@ def list_recurrent_charges(self,
                                headers: dict = None) -> httpx.Response:
         ''' Lists all recurrent charges.
             Args:
-                page (int): Navigate to specific page number.
+                page (int): Navigate to specific page number. Default: 1.
                 status (str): Filter charges by status. One of pending, accepted, active, declined, processed, failed or success.
                 order_client_id (str): Filter by specific `order_client_id`.
                 params (dict): Custom params to be used in request's query string.
@@ -255,7 +258,7 @@ def accept_recurrent_charge(self,
                                 charge_id: str,
                                 payload: dict = None,
                                 headers: dict = None) -> httpx.Response:
-        ''' Accpets specific reccurent charge.
+        ''' Accepets specific recurrent charge.
             Args:
                 charge_id (str): ID of the recurrent charge.
                 payload (dict): Custom payload to be used as request's data.
@@ -279,7 +282,7 @@ def decline_recurrent_charge(self,
                                  charge_id: str,
                                  payload: dict = None,
                                  headers: dict = None) -> httpx.Response:
-        ''' Declines specific reccurent charge.
+        ''' Declines specific recurrent charge.
             Args:
                 charge_id (str): ID of the recurrent charge.
                 payload (dict): Custom payload to be used as request's data.
@@ -303,7 +306,7 @@ def activate_recurrent_charge(self,
                                   charge_id: str,
                                   payload: dict = None,
                                   headers: dict = None) -> httpx.Response:
-        ''' Activates specific reccurent charge.
+        ''' Activates specific recurrent charge.
             Args:
                 charge_id (str): ID of the recurrent charge.
                 payload (dict): Custom payload to be used as request's data.
@@ -327,7 +330,7 @@ def cancel_recurrent_charge(self,
                                 charge_id: str,
                                 payload: dict = None,
                                 headers: dict = None) -> httpx.Response:
-        ''' Cancels specific reccurent charge.
+        ''' Cancels specific recurrent charge.
             Args:
                 charge_id (str): ID of the recurrent charge.
                 payload (dict): Custom payload to be used as request's data.

livechat/billing/base.py

@@ -5,16 +5,21 @@
 
 from __future__ import annotations
 
+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 = 'v1',
-                   base_url: str = 'billing.livechatinc.com',
+                   version: str = billing_version,
+                   base_url: str = billing_url,
                    http2: bool = False,
                    proxies: dict = None,
                    verify: bool = True) -> BillingApiV1:
@@ -23,7 +28,7 @@ def get_client(token: str,
             Args:
                 token (str): Full token with type Bearer that will be
                     used as `Authorization` header in requests to API.
-                version (str): API's version. Defaults to the v2 version of 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`.
@@ -40,7 +45,7 @@ def get_client(token: str,
                 ValueError: If the specified version does not exist.
         '''
         client = {
-            'v1': BillingApiV1(token, base_url, http2, proxies, verify),
+            '1': BillingApiV1(token, base_url, http2, proxies, verify),
         }.get(version)
         if not client:
             raise ValueError('Provided version does not exist.')

livechat/config.py

@@ -2,6 +2,8 @@
 
 CONFIG = {
     'url': 'api.livechatinc.com',
+    'billing_url': 'billing.livechatinc.com',
     'stable': '3.5',
     'dev': '3.6',
+    'billing_version': '1'
 }

livechat/tests/test_billing_api_client.py

@@ -5,6 +5,10 @@
 import pytest
 
 from livechat.billing.base import BillingApi
+from livechat.config import CONFIG
+
+billing_url = CONFIG.get('billing_url')
+billing_version = CONFIG.get('billing_version')
 
 
 @pytest.fixture
@@ -40,7 +44,7 @@ def test_get_client_with_non_existing_version():
 
 def test_get_client_with_valid_args(billing_api_client):
     ''' Test if production API URL is used and token is added to headers for valid args. '''
-    assert billing_api_client.api_url == 'https://billing.livechatinc.com/v1'
+    assert billing_api_client.api_url == f'https://{billing_url}/v{billing_version}'
     assert billing_api_client.session.headers.get('Authorization') == 'test'
 
 
@@ -83,10 +87,3 @@ def test_client_supports_http_1():
     ''' Test if client supports HTTP/1.1 protocol. '''
     client = BillingApi.get_client(token='test')
     assert client.create_direct_charge().http_version == 'HTTP/1.1'
-
-
-# At this point billing-api v1 support http2 but will always negotiate to use 'HTTP/1.1'
-# def test_client_supports_http_2():
-#     ''' Test if client supports HTTP/2 protocol. '''
-#     client = BillingApi.get_client(token='test', http2=True)
-#     assert client.create_direct_charge().http_version == 'HTTP/2'