Adding required level to User model (#277)

* Adding required_level field

* dev versions

* version

* reqs

* empty

Author: chiqeen03

cuenca/resources/users.py

@@ -30,6 +30,7 @@ class User(Creatable, Retrievable, Updateable, Queryable):
 
     identity_uri: str
     level: int
+    required_level: int
     created_at: dt.datetime
     phone_number: Optional[PhoneNumber]
     email_address: Optional[EmailStr]
@@ -48,6 +49,9 @@ class Config:
             'level': {
                 'description': 'Account level according to KYC information'
             },
+            'required_level': {
+                'description': 'Maximum level User can reach. Set by platform'
+            },
             'govt_id': {
                 'description': 'Detail of government id document validation'
             },
@@ -68,6 +72,7 @@ class Config:
                 'updated_at': '2019-08-24T14:15:22Z',
                 'identity_uri': 'identities/IDNEUInh69SuKXXmK95sROwQ',
                 'level': 2,
+                'required_level': 3,
                 'phone_number': '+525511223344',
                 'email_address': 'user@example.com',
                 'profession': 'engineer',
@@ -94,6 +99,7 @@ def create(
         address: Optional[Address] = None,
         email_verification_id: Optional[str] = None,
         phone_verification_id: Optional[str] = None,
+        required_level: Optional[int] = None,
         *,
         session: Session = global_session,
     ) -> 'User':
@@ -105,6 +111,7 @@ def create(
             address=address,
             email_verification_id=email_verification_id,
             phone_verification_id=phone_verification_id,
+            required_level=required_level,
         )
         return cast('User', cls._create(session=session, **req.dict()))
 

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.11.1'
+__version__ = '0.12.0'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

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

tests/resources/cassettes/test_session_create.yaml

@@ -78,7 +78,7 @@ interactions:
   response:
     body:
       string: "{\"id\":\"USz-lkjzCBTO2wFzR-FswiqA\",\"identity_uri\":\"/identities/IDKWLi_wUoTty6WXXg9xfKFQ\",\"created_at\":\"2022-02-09T18:29:24.685833\",\"updated_at\":\"2022-02-09T18:29:24.715958\",\"platform_id\":\"PTW68GgAc_QPmNCmgajmctLg\",\"level\":0,\"phone_number\":\"+525511223344\",\"email_address\":\"jose@test.com\",\"profession\":\"employee\",\"status\":\"active\",\"terms_of_service\":null,\"blacklist_validation_status\":\"not_verified\",\"address\":{\"street\":\"calle
-        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T18:29:24.685718\"},\"govt_id\":null,\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\"}"
+        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T18:29:24.685718\"},\"govt_id\":null,\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\",\"required_level\":4}"
     headers:
       Connection:
       - keep-alive
@@ -181,7 +181,7 @@ interactions:
   response:
     body:
       string: "{\"id\":\"USz-lkjzCBTO2wFzR-FswiqA\",\"identity_uri\":\"/identities/IDKWLi_wUoTty6WXXg9xfKFQ\",\"created_at\":\"2022-02-09T18:29:24.685000\",\"updated_at\":\"2022-02-09T18:29:25.958447\",\"platform_id\":\"PTW68GgAc_QPmNCmgajmctLg\",\"level\":0,\"phone_number\":\"+525511223344\",\"email_address\":\"manu@example.com\",\"profession\":\"employee\",\"status\":\"active\",\"terms_of_service\":null,\"blacklist_validation_status\":\"not_verified\",\"address\":{\"street\":\"calle
-        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T18:29:24.685000\"},\"govt_id\":null,\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\"}"
+        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T18:29:24.685000\"},\"govt_id\":null,\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\",\"required_level\":4}"
     headers:
       Connection:
       - keep-alive

tests/resources/cassettes/test_user_create.yaml

@@ -78,7 +78,7 @@ interactions:
   response:
     body:
       string: "{\"id\":\"USCM-zlFcNQk6ue4gZ_mTGeQ\",\"identity_uri\":\"/identities/IDKWLi_wUoTty6WXXg9xfKFQ\",\"created_at\":\"2022-02-09T17:42:56.965055\",\"updated_at\":\"2022-02-09T17:42:57.008600\",\"platform_id\":\"PTW68GgAc_QPmNCmgajmctLg\",\"level\":0,\"phone_number\":\"+525511223344\",\"email_address\":\"jose@test.com\",\"profession\":\"employee\",\"status\":\"active\",\"terms_of_service\":null,\"blacklist_validation_status\":\"not_verified\",\"address\":{\"street\":\"calle
-        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T17:42:56.964930\"},\"govt_id\":null,\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\"}"
+        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T17:42:56.964930\"},\"govt_id\":null,\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\",\"required_level\":4}"
     headers:
       Connection:
       - keep-alive

tests/resources/cassettes/test_user_identity_retrieve.yaml

@@ -19,7 +19,7 @@ interactions:
   response:
     body:
       string: "{\"id\":\"USCM-zlFcNQk6ue4gZ_mTGeQ\",\"identity_uri\":\"/identities/IDKWLi_wUoTty6WXXg9xfKFQ\",\"created_at\":\"2022-02-09T17:42:56.965000\",\"updated_at\":\"2022-02-09T17:50:41.964000\",\"platform_id\":\"PTW68GgAc_QPmNCmgajmctLg\",\"level\":0,\"phone_number\":\"+525555555555\",\"email_address\":\"jose@test.com\",\"profession\":\"programmer\",\"status\":\"active\",\"terms_of_service\":null,\"blacklist_validation_status\":\"succeeded\",\"address\":{\"street\":\"calle
-        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T17:42:56.964000\"},\"govt_id\":{\"type\":\"ine\",\"uri_front\":\"cuenca.com\",\"uri_back\":\"cuenca.com\",\"is_mx\":true,\"data\":{},\"status\":\"not_verified\"},\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\"}"
+        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T17:42:56.964000\"},\"govt_id\":{\"type\":\"ine\",\"uri_front\":\"cuenca.com\",\"uri_back\":\"cuenca.com\",\"is_mx\":true,\"data\":{},\"status\":\"not_verified\"},\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\",\"required_level\":4}"
     headers:
       Connection:
       - keep-alive

tests/resources/cassettes/test_user_query.yaml

@@ -18,7 +18,7 @@ interactions:
     uri: https://sandbox.cuenca.com/users?limit=2&email_address=jose%40test.com
   response:
     body:
-      string: "{\"items\":[{\"id\":\"USCM-zlFcNQk6ue4gZ_mTGeQ\",\"identity_uri\":\"/identities/IDKWLi_wUoTty6WXXg9xfKFQ\",\"created_at\":\"2022-02-09T17:42:56.965000\",\"updated_at\":\"2022-02-09T17:43:05.423000\",\"platform_id\":\"PTW68GgAc_QPmNCmgajmctLg\",\"level\":0,\"phone_number\":\"+525511223344\",\"email_address\":\"jose@test.com\",\"profession\":\"employee\",\"status\":\"active\",\"terms_of_service\":null,\"blacklist_validation_status\":\"succeeded\",\"address\":{\"street\":\"calle
+      string: "{\"items\":[{\"id\":\"USCM-zlFcNQk6ue4gZ_mTGeQ\",\"identity_uri\":\"/identities/IDKWLi_wUoTty6WXXg9xfKFQ\",\"created_at\":\"2022-02-09T17:42:56.965000\",\"updated_at\":\"2022-02-09T17:43:05.423000\",\"platform_id\":\"PTW68GgAc_QPmNCmgajmctLg\",\"level\":0,\"required_level\":4,\"phone_number\":\"+525511223344\",\"email_address\":\"jose@test.com\",\"profession\":\"employee\",\"status\":\"active\",\"terms_of_service\":null,\"blacklist_validation_status\":\"succeeded\",\"address\":{\"street\":\"calle
         1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T17:42:56.964000\"},\"govt_id\":null,\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\"}],\"next_page_uri\":null}"
     headers:
       Connection:

tests/resources/cassettes/test_user_query_all_identity_id.yaml

@@ -18,8 +18,8 @@ interactions:
     uri: https://sandbox.cuenca.com/users?identity_uri=IDzqdGEBX_SMScteGcRDNtOg
   response:
     body:
-      string: '{"items":[{"id":"US48qRpnZOQuKoAF1j_mnZ7Q","created_at":"2022-05-05T18:35:14.597000","updated_at":"2022-05-19T23:40:30.372000","identity_uri":"/identities/IDzqdGEBX_SMScteGcRDNtOg","level":2,"phone_number":"+525566556655","email_address":"alan@cuenca.com","profession":"employee","terms_of_service":{"version":"2022-01-01","ip":"201.141.24.14","location":null},"status":"active","address":{"street":null,"ext_number":null,"postal_code":null,"state":null,"country":null,"city":null,"int_number":null,"full_name":"RTNO
-        1"},"govt_id":{"type":"ine","is_mx":true,"uri_front":"cuenca.com","uri_back":"cuenca.com","data":{}},"proof_of_address":null,"proof_of_life":null,"beneficiaries":null,"platform_id":"PTSFitwBYWROu-dAziDnSr4Q"},{"id":"USH19aFDPCTbetWNiltoqPyA","created_at":"2022-04-29T01:54:49.537000","updated_at":"2022-05-04T23:11:33.845000","identity_uri":"/identities/IDzqdGEBX_SMScteGcRDNtOg","level":3,"phone_number":"+525566778899","email_address":"yisus@cuenca.com","profession":null,"terms_of_service":{"version":"2022-01-01","ip":"10.0.23.99","location":null},"status":"active","address":null,"govt_id":{"type":"ine","is_mx":true,"uri_front":"cuenca.com","uri_back":"cuenca.com","data":{}},"proof_of_address":{"type":"proof_of_address","is_mx":true,"uri_front":"cuenca.com","uri_back":null,"data":{}},"proof_of_life":null,"beneficiaries":null,"platform_id":"PTW68GgAc_QPmNCmgajmctLg"}],"next_page_uri":null,"count":null,"fields":{"items":{"description":"List
+      string: '{"items":[{"id":"US48qRpnZOQuKoAF1j_mnZ7Q","created_at":"2022-05-05T18:35:14.597000","updated_at":"2022-05-19T23:40:30.372000","identity_uri":"/identities/IDzqdGEBX_SMScteGcRDNtOg","level":2,"required_level":4,"phone_number":"+525566556655","email_address":"alan@cuenca.com","profession":"employee","terms_of_service":{"version":"2022-01-01","ip":"201.141.24.14","location":null},"status":"active","address":{"street":null,"ext_number":null,"postal_code":null,"state":null,"country":null,"city":null,"int_number":null,"full_name":"RTNO
+        1"},"govt_id":{"type":"ine","is_mx":true,"uri_front":"cuenca.com","uri_back":"cuenca.com","data":{}},"proof_of_address":null,"proof_of_life":null,"beneficiaries":null,"platform_id":"PTSFitwBYWROu-dAziDnSr4Q"},{"id":"USH19aFDPCTbetWNiltoqPyA","created_at":"2022-04-29T01:54:49.537000","updated_at":"2022-05-04T23:11:33.845000","identity_uri":"/identities/IDzqdGEBX_SMScteGcRDNtOg","level":3,"required_level":4,"phone_number":"+525566778899","email_address":"yisus@cuenca.com","profession":null,"terms_of_service":{"version":"2022-01-01","ip":"10.0.23.99","location":null},"status":"active","address":null,"govt_id":{"type":"ine","is_mx":true,"uri_front":"cuenca.com","uri_back":"cuenca.com","data":{}},"proof_of_address":{"type":"proof_of_address","is_mx":true,"uri_front":"cuenca.com","uri_back":null,"data":{}},"proof_of_life":null,"beneficiaries":null,"platform_id":"PTW68GgAc_QPmNCmgajmctLg"}],"next_page_uri":null,"count":null,"fields":{"items":{"description":"List
         of Users that match with query filters"},"next_page_uri":{"description":"URL
         to fetch the next page of results"},"count":{"description":"Counter of Users
         objects that match with query filters.  \nIncluded in response only if `count`

tests/resources/cassettes/test_user_query_by_identity_id.yaml

@@ -18,7 +18,7 @@ interactions:
     uri: https://sandbox.cuenca.com/users?limit=1&identity_uri=IDzqdGEBX_SMScteGcRDNtOg
   response:
     body:
-      string: '{"items":[{"id":"US1234","created_at":"2022-05-05T18:35:14.597000","updated_at":"2022-05-19T23:40:30.372000","identity_uri":"/identities/IDzqdGEBX_SMScteGcRDNtOg","level":2,"phone_number":"+525512345678","email_address":"alan@cuenca.com","profession":"employee","terms_of_service":{"version":"2022-01-01","ip":"201.141.24.14","location":null},"status":"active","address":{"street":null,"ext_number":null,"postal_code":null,"state":null,"country":null,"city":null,"int_number":null,"full_name":"RTNO
+      string: '{"items":[{"id":"US1234","created_at":"2022-05-05T18:35:14.597000","updated_at":"2022-05-19T23:40:30.372000","identity_uri":"/identities/IDzqdGEBX_SMScteGcRDNtOg","level":2,"required_level":4,"phone_number":"+525512345678","email_address":"alan@cuenca.com","profession":"employee","terms_of_service":{"version":"2022-01-01","ip":"201.141.24.14","location":null},"status":"active","address":{"street":null,"ext_number":null,"postal_code":null,"state":null,"country":null,"city":null,"int_number":null,"full_name":"RTNO
         1"},"govt_id":{"type":"ine","is_mx":true,"uri_front": "cuenca.com", "uri_back":
         "cuenca.com","data":{}},"proof_of_address":null,"proof_of_life":null,"beneficiaries":null,"platform_id":"PT12334"}],"next_page_uri":null,"count":null,"fields":{"items":{"description":"List
         of Users that match with query filters"},"next_page_uri":{"description":"URL

tests/resources/cassettes/test_user_update.yaml

@@ -25,7 +25,7 @@ interactions:
   response:
     body:
       string: "{\"id\":\"USCM-zlFcNQk6ue4gZ_mTGeQ\",\"identity_uri\":\"/identities/IDKWLi_wUoTty6WXXg9xfKFQ\",\"created_at\":\"2022-02-09T17:42:56.965000\",\"updated_at\":\"2022-02-09T17:50:41.964498\",\"platform_id\":\"PTW68GgAc_QPmNCmgajmctLg\",\"level\":0,\"phone_number\":\"+525555555555\",\"email_address\":\"jose@test.com\",\"profession\":\"programmer\",\"status\":\"active\",\"terms_of_service\":null,\"blacklist_validation_status\":\"succeeded\",\"address\":{\"street\":\"calle
-        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T17:42:56.964000\"},\"govt_id\":{\"type\":\"ine\",\"uri_front\":\"cuenca.com\",\"uri_back\":\"cuenca.com\",\"is_mx\":true,\"data\":{},\"status\":\"not_verified\"},\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\"}"
+        1\",\"ext_number\":\"2\",\"int_number\":\"3\",\"postal_code\":\"09900\",\"state\":\"DF\",\"city\":null,\"country\":\"MX\",\"created_at\":\"2022-02-09T17:42:56.964000\"},\"govt_id\":{\"type\":\"ine\",\"uri_front\":\"cuenca.com\",\"uri_back\":\"cuenca.com\",\"is_mx\":true,\"data\":{},\"status\":\"not_verified\"},\"proof_of_address\":null,\"proof_of_life\":null,\"beneficiaries\":null,\"names\":\"Jos\xE9\",\"first_surname\":\"L\xF3pez\",\"second_surname\":\"Hern\xE1ndez\",\"curp\":\"LOHJ660606HDFPRS02\",\"required_level\":4}"
     headers:
       Connection:
       - keep-alive