incognia-python 3.1.0__tar.gz → 3.3.0__tar.gz

{incognia_python-3.1.0 → incognia_python-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: incognia-python
-Version: 3.1.0
+Version: 3.3.0
 Summary: Python lightweight client library for Incognia APIs
 Home-page: https://github.com/inloco/incognia-python
 Author: Incognia

{incognia_python-3.1.0 → incognia_python-3.3.0}/incognia/api.py

@@ -13,6 +13,8 @@ from .models import (
     PaymentMethod,
     Location,
     Coupon,
+    PersonID,
+    BankAccountInfo,
 )
 from .singleton import Singleton
 from .token_manager import TokenManager
@@ -37,7 +39,9 @@ class IncogniaAPI(metaclass=Singleton):
                             policy_id: Optional[str] = None,
                             account_id: Optional[str] = None,
                             device_os: Optional[str] = None,
-                            app_version: Optional[str] = None) -> dict:
+                            app_version: Optional[str] = None,
+                            person_id: Optional[PersonID] = None,
+                            custom_properties: Optional[dict] = None) -> dict:
         if not request_token:
             raise IncogniaError('request_token is required.')
 
@@ -53,7 +57,9 @@ class IncogniaAPI(metaclass=Singleton):
                 'policy_id': policy_id,
                 'account_id': account_id,
                 'device_os': device_os.lower() if device_os is not None else None,
-                'app_version': app_version
+                'app_version': app_version,
+                'person_id': person_id,
+                'custom_properties': custom_properties
             }
             data = encode(body)
             return self.__request.post(Endpoints.SIGNUPS, headers=headers, data=data)
@@ -66,7 +72,7 @@ class IncogniaAPI(metaclass=Singleton):
                                 policy_id: Optional[str] = None,
                                 account_id: Optional[str] = None,
                                 custom_properties: Optional[dict] = None,
-                                ) -> dict:
+                                person_id: Optional[PersonID] = None) -> dict:
         if not request_token:
             raise IncogniaError('request_token is required.')
 
@@ -77,7 +83,8 @@ class IncogniaAPI(metaclass=Singleton):
                 'request_token': request_token,
                 'policy_id': policy_id,
                 'account_id': account_id,
-                'custom_properties': custom_properties
+                'custom_properties': custom_properties,
+                'person_id': person_id,
             }
             data = encode(body)
             return self.__request.post(Endpoints.SIGNUPS, headers=headers, data=data)
@@ -95,7 +102,8 @@ class IncogniaAPI(metaclass=Singleton):
                           installation_id: Optional[str] = None,
                           request_token: Optional[str] = None,
                           occurred_at: dt.datetime = None,
-                          expires_at: dt.datetime = None) -> None:
+                          expires_at: dt.datetime = None,
+                          person_id: Optional[PersonID] = None) -> None:
         if not event:
             raise IncogniaError('event is required.')
         if occurred_at is not None and not has_timezone(occurred_at):
@@ -114,7 +122,8 @@ class IncogniaAPI(metaclass=Singleton):
                 'signup_id': signup_id,
                 'account_id': account_id,
                 'installation_id': installation_id,
-                'request_token': request_token
+                'request_token': request_token,
+                'person_id': person_id,
             }
             if occurred_at is not None:
                 body['occurred_at'] = occurred_at.isoformat()
@@ -140,7 +149,10 @@ class IncogniaAPI(metaclass=Singleton):
                          coupon: Optional[Coupon] = None,
                          device_os: Optional[str] = None,
                          app_version: Optional[str] = None,
-                         store_id: Optional[str] = None) -> dict:
+                         store_id: Optional[str] = None,
+                         person_id: Optional[PersonID] = None,
+                         debtor_account: Optional[BankAccountInfo] = None,
+                         creditor_account: Optional[BankAccountInfo] = None) -> dict:
         if not request_token:
             raise IncogniaError('request_token is required.')
         if not account_id:
@@ -175,6 +187,9 @@ class IncogniaAPI(metaclass=Singleton):
                 'device_os': device_os.lower() if device_os is not None else None,
                 'app_version': app_version,
                 'store_id': store_id,
+                'person_id': person_id,
+                'debtor_account': debtor_account,
+                'creditor_account': creditor_account,
             }
             data = encode(body)
             return self.__request.post(Endpoints.TRANSACTIONS, headers=headers, params=params,
@@ -191,7 +206,8 @@ class IncogniaAPI(metaclass=Singleton):
                        evaluate: Optional[bool] = None,
                        policy_id: Optional[str] = None,
                        device_os: Optional[str] = None,
-                       app_version: Optional[str] = None) -> dict:
+                       app_version: Optional[str] = None,
+                       person_id: Optional[PersonID] = None) -> dict:
         if not request_token:
             raise IncogniaError('request_token is required.')
         if not account_id:
@@ -220,6 +236,7 @@ class IncogniaAPI(metaclass=Singleton):
                 'policy_id': policy_id,
                 'device_os': device_os.lower() if device_os is not None else None,
                 'app_version': app_version,
+                'person_id': person_id,
             }
             data = encode(body)
             return self.__request.post(Endpoints.TRANSACTIONS, headers=headers, params=params,
@@ -234,7 +251,8 @@ class IncogniaAPI(metaclass=Singleton):
                            external_id: Optional[str] = None,
                            evaluate: Optional[bool] = None,
                            policy_id: Optional[str] = None,
-                           custom_properties: Optional[dict] = None) -> dict:
+                           custom_properties: Optional[dict] = None,
+                           person_id: Optional[PersonID] = None) -> dict:
         if not request_token:
             raise IncogniaError('request_token is required.')
         if not account_id:
@@ -251,6 +269,7 @@ class IncogniaAPI(metaclass=Singleton):
                 'external_id': external_id,
                 'policy_id': policy_id,
                 'custom_properties': custom_properties,
+                'person_id': person_id,
             }
             data = encode(body)
             return self.__request.post(Endpoints.TRANSACTIONS, headers=headers, params=params,

{incognia_python-3.1.0 → incognia_python-3.3.0}/incognia/models.py

@@ -1,4 +1,4 @@
-from typing import TypedDict, Literal
+from typing import TypedDict, Literal, List
 
 
 class Coordinates(TypedDict):
@@ -58,3 +58,26 @@ class Location(TypedDict, total=False):
     latitude: float
     longitude: float
     collected_at: str
+
+
+class PersonID(TypedDict, total=False):
+    type: str
+    value: str
+
+
+class PixKey(TypedDict):
+    type: str
+    value: str
+
+
+class BankAccountInfo(TypedDict, total=False):
+    account_type: str
+    account_purpose: str
+    holder_type: str
+    holder_tax_id: PersonID
+    country: str
+    ispb_code: str
+    branch_code: str
+    account_number: str
+    account_check_digit: str
+    pix_keys: List[PixKey]

{incognia_python-3.1.0 → incognia_python-3.3.0}/incognia_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: incognia-python
-Version: 3.1.0
+Version: 3.3.0
 Summary: Python lightweight client library for Incognia APIs
 Home-page: https://github.com/inloco/incognia-python
 Author: Incognia

{incognia_python-3.1.0 → incognia_python-3.3.0}/tests/test_api.py

@@ -22,6 +22,10 @@ class TestIncogniaAPI(TestCase):
     ADDRESS_LINE: Final[str] = 'ANY_ADDRESS_LINE'
     DEVICE_OS: Final[str] = 'ANY_DEVICE_OS'
     APP_VERSION: Final[str] = 'ANY_APP_VERSION'
+    PERSON_ID: Final[dict] = {
+        'type': 'cpf',
+        'value': '12345678901'
+    }
     STRUCTURED_ADDRESS: Final[dict] = {
         'locale': 'ANY_LOCALE',
         'country_name': 'ANY_COUNTRY_NAME',
@@ -62,6 +66,10 @@ class TestIncogniaAPI(TestCase):
     REGISTER_INVALID_SIGNUP_DATA: Final[bytes] = encode({
         'request_token': f'{INVALID_REQUEST_TOKEN}'
     })
+    CUSTOM_PROPERTIES: Final[dict] = {
+        'float_field': 6.092,
+        'string_field': "the next generation of identity",
+    }
     FULL_REGISTER_SIGNUP_DATA: Final[bytes] = encode({
         'request_token': f'{REQUEST_TOKEN}',
         'address_line': f'{ADDRESS_LINE}',
@@ -71,12 +79,10 @@ class TestIncogniaAPI(TestCase):
         'policy_id': f'{POLICY_ID}',
         'account_id': f'{ACCOUNT_ID}',
         'device_os': f'{DEVICE_OS.lower()}',
-        'app_version': f'{APP_VERSION}'
+        'app_version': f'{APP_VERSION}',
+        'person_id': PERSON_ID,
+        'custom_properties': CUSTOM_PROPERTIES
     })
-    CUSTOM_PROPERTIES: Final[dict] = {
-        'float_field': 6.092,
-        'string_field': "the next generation of identity",
-    }
     REGISTER_WEB_SIGNUP_DATA: Final[bytes] = encode({
         'request_token': f'{REQUEST_TOKEN}'
     })
@@ -87,7 +93,8 @@ class TestIncogniaAPI(TestCase):
         'request_token': f'{REQUEST_TOKEN}',
         'policy_id': f'{POLICY_ID}',
         'account_id': f'{ACCOUNT_ID}',
-        'custom_properties': CUSTOM_PROPERTIES
+        'custom_properties': CUSTOM_PROPERTIES,
+        'person_id': PERSON_ID
     })
     OK_STATUS_CODE: Final[int] = 200
     CLIENT_ERROR_CODE: Final[int] = 400
@@ -143,6 +150,24 @@ class TestIncogniaAPI(TestCase):
         'longitude': 13.123,
         'collected_at': "12:04 14/10/2024"
     }
+    BANK_ACCOUNT_INFO: Final[dict] = {
+        "account_type": "checking",
+        "account_purpose": "personal",
+        "holder_type": "individual",
+        "holder_tax_id": {
+            "type": "cpf",
+            "value": "12345678900",
+        },
+        "country": "BR",
+        "ispb_code": "12345678",
+        "branch_code": "0001",
+        "account_number": "987654",
+        "account_check_digit": "0",
+        "pix_keys": [
+            {"type": "email", "value": "user@example.com"},
+            {"type": "phone", "value": "+5511999999999"},
+        ],
+    }
     REGISTER_VALID_FEEDBACK_DATA: Final[bytes] = encode({
         'event': f'{VALID_EVENT_FEEDBACK_TYPE}'
     })
@@ -155,8 +180,9 @@ class TestIncogniaAPI(TestCase):
         'account_id': f'{ACCOUNT_ID}',
         'installation_id': f'{INSTALLATION_ID}',
         'request_token': f'{REQUEST_TOKEN}',
+        'person_id': PERSON_ID,
         'occurred_at': TIMESTAMP.isoformat(),
-        'expires_at': TIMESTAMP.isoformat(),
+        'expires_at': TIMESTAMP.isoformat()
     })
     REGISTER_VALID_PAYMENT_DATA: Final[bytes] = encode({
         'type': 'payment',
@@ -178,7 +204,10 @@ class TestIncogniaAPI(TestCase):
         'coupon': COUPON,
         'device_os': f'{DEVICE_OS.lower()}',
         'app_version': f'{APP_VERSION}',
-        'store_id': f'{STORE_ID}'
+        'store_id': f'{STORE_ID}',
+        'person_id': PERSON_ID,
+        'debtor_account': BANK_ACCOUNT_INFO,
+        'creditor_account': BANK_ACCOUNT_INFO
     })
     REGISTER_VALID_PAYMENT_DATA_WITH_LOCATION: Final[bytes] = encode({
         'type': 'payment',
@@ -213,7 +242,8 @@ class TestIncogniaAPI(TestCase):
         'external_id': f'{EXTERNAL_ID}',
         'policy_id': f'{POLICY_ID}',
         'device_os': f'{DEVICE_OS.lower()}',
-        'app_version': f'{APP_VERSION}'
+        'app_version': f'{APP_VERSION}',
+        'person_id': PERSON_ID
     })
     REGISTER_VALID_WEB_LOGIN_DATA: Final[bytes] = encode({
         'type': 'login',
@@ -227,7 +257,8 @@ class TestIncogniaAPI(TestCase):
         'account_id': f'{ACCOUNT_ID}',
         'external_id': f'{EXTERNAL_ID}',
         'policy_id': f'{POLICY_ID}',
-        'custom_properties': CUSTOM_PROPERTIES
+        'custom_properties': CUSTOM_PROPERTIES,
+        'person_id': PERSON_ID
     })
     REGISTER_INVALID_LOGIN_DATA: Final[bytes] = encode({
         'type': 'login',
@@ -294,7 +325,9 @@ class TestIncogniaAPI(TestCase):
                                            account_id=self.ACCOUNT_ID,
                                            request_token=self.REQUEST_TOKEN,
                                            device_os=self.DEVICE_OS,
-                                           app_version=self.APP_VERSION)
+                                           app_version=self.APP_VERSION,
+                                           person_id=self.PERSON_ID,
+                                           custom_properties=self.CUSTOM_PROPERTIES)
 
         mock_token_manager_get.assert_called()
         mock_base_request_post.assert_called_with(Endpoints.SIGNUPS,
@@ -313,7 +346,8 @@ class TestIncogniaAPI(TestCase):
         response = api.register_new_web_signup(request_token=self.REQUEST_TOKEN,
                                                policy_id=self.POLICY_ID,
                                                account_id=self.ACCOUNT_ID,
-                                               custom_properties=self.CUSTOM_PROPERTIES)
+                                               custom_properties=self.CUSTOM_PROPERTIES,
+                                               person_id=self.PERSON_ID)
 
         mock_token_manager_get.assert_called()
         mock_base_request_post.assert_called_with(Endpoints.SIGNUPS,
@@ -403,7 +437,8 @@ class TestIncogniaAPI(TestCase):
                               signup_id=self.SIGNUP_ID,
                               account_id=self.ACCOUNT_ID,
                               installation_id=self.INSTALLATION_ID,
-                              request_token=self.REQUEST_TOKEN)
+                              request_token=self.REQUEST_TOKEN,
+                              person_id=self.PERSON_ID)
 
         mock_token_manager_get.assert_called()
         mock_base_request_post.assert_called_with(Endpoints.FEEDBACKS,
@@ -490,7 +525,10 @@ class TestIncogniaAPI(TestCase):
             coupon=self.COUPON,
             device_os=self.DEVICE_OS,
             app_version=self.APP_VERSION,
-            store_id=self.STORE_ID
+            store_id=self.STORE_ID,
+            person_id=self.PERSON_ID,
+            debtor_account=self.BANK_ACCOUNT_INFO,
+            creditor_account=self.BANK_ACCOUNT_INFO
         )
 
         mock_token_manager_get.assert_called()
@@ -641,7 +679,8 @@ class TestIncogniaAPI(TestCase):
                                                   self.ACCOUNT_ID,
                                                   external_id=self.EXTERNAL_ID,
                                                   policy_id=self.POLICY_ID,
-                                                  custom_properties=self.CUSTOM_PROPERTIES)
+                                                  custom_properties=self.CUSTOM_PROPERTIES,
+                                                  person_id=self.PERSON_ID)
         mock_token_manager_get.assert_called()
         mock_base_request_post.assert_called_with(Endpoints.TRANSACTIONS,
                                                   headers=self.AUTH_AND_JSON_CONTENT_HEADERS,
@@ -731,7 +770,8 @@ class TestIncogniaAPI(TestCase):
                                               external_id=self.EXTERNAL_ID,
                                               policy_id=self.POLICY_ID,
                                               device_os=self.DEVICE_OS,
-                                              app_version=self.APP_VERSION)
+                                              app_version=self.APP_VERSION,
+                                              person_id=self.PERSON_ID)
 
         mock_token_manager_get.assert_called()
         mock_base_request_post.assert_called_with(Endpoints.TRANSACTIONS,