Kyc validations (#318)

* draft kyc validations

* adding KycValidationRequest

* format

* expose resource

* bump validations

* fix imports

* starting test and upgrade CV

* bump validations

* version and fix test

* lint

* queryable

* update docs

* fix test

Author: alexviquez

cuenca/__init__.py

@@ -19,6 +19,7 @@
     'FileBatch',
     'Identity',
     'IdentityEvent',
+    'KYCValidation',
     'KYCVerification',
     'LimitedWallet',
     'LoginToken',
@@ -63,6 +64,7 @@
     FileBatch,
     Identity,
     IdentityEvent,
+    KYCValidation,
     KYCVerification,
     LimitedWallet,
     LoginToken,

cuenca/resources/__init__.py

@@ -18,6 +18,7 @@
     'FileBatch',
     'Identity',
     'IdentityEvent',
+    'KYCValidation',
     'KYCVerification',
     'LimitedWallet',
     'LoginToken',
@@ -55,6 +56,7 @@
 from .files import File
 from .identities import Identity
 from .identity_events import IdentityEvent
+from .kyc_validations import KYCValidation
 from .kyc_verifications import KYCVerification
 from .limited_wallets import LimitedWallet
 from .login_tokens import LoginToken
@@ -95,6 +97,7 @@
     FileBatch,
     Identity,
     IdentityEvent,
+    KYCValidation,
     KYCVerification,
     LimitedWallet,
     LoginToken,

cuenca/resources/kyc_validations.py

@@ -0,0 +1,35 @@
+from typing import ClassVar, List, Optional, cast
+
+from cuenca_validations.types import KYCValidationRequest
+
+from ..http import Session, session as global_session
+from .base import Creatable, Queryable, Retrievable
+
+
+class KYCValidation(Creatable, Retrievable, Queryable):
+    _resource: ClassVar = 'kyc_validations'
+    platform_id: str
+    attemps: Optional[int]
+    verification_id: Optional[str]
+    files_uri: Optional[List[str]]
+
+    class Config:
+        schema_extra = {
+            'example': {
+                'id': 'KVNEUInh69SuKXXmK95sROwQ',
+                'platform_id': 'PT8UEv02zBTcymd4Kd3MO6pg',
+                'created_at': '2020-05-24T14:15:22Z',
+                'verification_id': 'string',
+                'files_uri': ['cuenca.com/files/id', 'cuenca.com/files/id2'],
+                'attemps': '1',
+            }
+        }
+
+    @classmethod
+    def create(
+        cls, user_id: str, session: Session = global_session
+    ) -> 'KYCValidation':
+        req = KYCValidationRequest(user_id=user_id)
+        return cast(
+            'KYCValidation', cls._create(**req.dict(), session=session)
+        )

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.14.5'
+__version__ = '0.14.6'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

@@ -1,3 +1,3 @@
 requests==2.27.1
-cuenca-validations==0.11.3
+cuenca-validations==0.11.4
 dataclasses>=0.7;python_version<"3.7"

tests/resources/cassettes/test_validation_create.yaml

@@ -0,0 +1,52 @@
+interactions:
+- request:
+    body: '{"user_id": "USFOOBAR"}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '39'
+      Content-Type:
+      - application/json
+      User-Agent:
+      - cuenca-python/0.14.7.dev6
+      X-Cuenca-Api-Version:
+      - '2020-03-19'
+    method: POST
+    uri: https://sandbox.cuenca.com/kyc_validations
+  response:
+    body:
+      string: '{"id":"KVWZUhh-t_RUOPvU3hOnhbsQ","created_at":"2022-09-26T23:14:28.686030","verification_id":"6332324ca3b3cd001c6bcbf9","platform_id":"PTS7Wx1-1KRCKHQRWXsqxbMQ","user_id":"USOiwY3bhaRO-Or9koIBaehg","files_uri":["''https://sandbox.cuenca.com/files/EFfX_JE_wES3KA5cuR075rVA","https://sandbox.cuenca.com/files/EFWUXd3zl6Q6Gmd1tD2S65fw","https://sandbox.cuenca.com/files/EF2_YXyrMLSba7wpz-DQGgsw"]}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '393'
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 26 Sep 2022 23:14:28 GMT
+      X-Request-Time:
+      - 'value: 27.792'
+      x-amz-apigw-id:
+      - ZFzI7GHfoAMF4jQ=
+      x-amzn-Remapped-Connection:
+      - keep-alive
+      x-amzn-Remapped-Content-Length:
+      - '393'
+      x-amzn-Remapped-Date:
+      - Mon, 26 Sep 2022 23:14:28 GMT
+      x-amzn-Remapped-Server:
+      - nginx/1.22.0
+      x-amzn-RequestId:
+      - 310039b7-a7dd-4980-bb0b-b5552c602d26
+    status:
+      code: 201
+      message: Created
+version: 1

tests/resources/cassettes/test_validation_retrieve.yaml

@@ -0,0 +1,48 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      User-Agent:
+      - cuenca-python/0.14.7.dev6
+      X-Cuenca-Api-Version:
+      - '2020-03-19'
+    method: GET
+    uri: https://sandbox.cuenca.com/kyc_validations/KVFOO
+  response:
+    body:
+      string: '{"id":"KVWZUhh-t_RUOPvU3hOnhbsQ","platform_id":"PTS7Wx1-1KRCKHQRWXsqxbMQ","created_at":"2022-09-26T23:14:28.686000","verification_id":"6332324ca3b3cd001c6bcbf9","govt_id":null,"proof_of_address":null,"proof_of_life":null}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '221'
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 26 Sep 2022 23:15:11 GMT
+      X-Request-Time:
+      - 'value: 0.074'
+      x-amz-apigw-id:
+      - ZFzT4HnLIAMFe1w=
+      x-amzn-Remapped-Connection:
+      - keep-alive
+      x-amzn-Remapped-Content-Length:
+      - '221'
+      x-amzn-Remapped-Date:
+      - Mon, 26 Sep 2022 23:15:11 GMT
+      x-amzn-Remapped-Server:
+      - nginx/1.22.0
+      x-amzn-RequestId:
+      - 54f8a828-94f3-4303-8c95-95e22472cbab
+    status:
+      code: 200
+      message: OK
+version: 1

tests/resources/test_kyc_validations.py

@@ -0,0 +1,17 @@
+import pytest
+
+from cuenca import KYCValidation
+
+
+@pytest.mark.vcr
+def test_validation_create():
+    kyc_validation: KYCValidation = KYCValidation.create(user_id="USFOOBAR")
+    assert kyc_validation.id
+    assert kyc_validation.verification_id
+
+
+@pytest.mark.vcr
+def test_validation_retrieve():
+    kyc_validation = KYCValidation.retrieve('KVFOO')
+    assert kyc_validation.id
+    assert kyc_validation.verification_id