Merge pull request #152 from bunq/feature/sdk_python#151_remove_user_sandbox

feature/sdk_python#151 Deprecated SandboxUser and replaced it with SandboxUserPerson/Company

Author: angelomelonas

README.md

@@ -82,7 +82,7 @@ Creating objects through the API requires an `ApiContext`, a `requestMap` and id
 dependencies (such as User ID required for accessing a Monetary Account). Optionally, custom headers
 can be passed to requests.
 
-    payment_id = endpoint.Payment.create(
+    payment_id = Payment.create(
         amount=Amount(amount_string, self._CURRENCY_EURL),
         counterparty_alias=Pointer(self._POINTER_TYPE_EMAIL, recipient),
         description=description
@@ -109,7 +109,7 @@ See [`tinker/list_all_payment`](https://github.com/bunq/tinker_python/blob/2182b
 Updating objects through the API goes the same way as creating objects, except that also the object to update identifier 
 (ID or UUID) is needed.
 
-    endpoint.Card.update(
+    Card.update(
         card_id=int(card_id),
         monetary_account_current_id=int(account_id)
     )
@@ -130,7 +130,7 @@ passed to requests.
 Listing objects through the API requires an `ApiContext` and identifiers of all dependencies (such as User ID required
 for accessing a Monetary Account). Optionally, custom headers can be passed to requests.
 
-    users = endpoint.User.list(api_context)
+    users = User.list(api_context)
 
 ##### Example
 See [`UserListExample.py`](./examples/user_list_example.py)

bunq/__init__.py

@@ -5,6 +5,7 @@
 from bunq.sdk.http.pagination import Pagination
 from bunq.sdk.json import converter
 from bunq.sdk.model.core.anchor_object_interface import AnchorObjectInterface
+from bunq.sdk.model.generated.object_ import Geolocation, ShareDetail, MonetaryAccountReference
 from bunq.sdk.util.type_alias import T
 
 
@@ -36,9 +37,9 @@ def initialize_converter() -> None:
     converter.register_adapter(InstallationContext, InstallationContextAdapter)
     converter.register_adapter(ApiEnvironmentType, ApiEnvironmentTypeAdapter)
     converter.register_adapter(float, FloatAdapter)
-    converter.register_adapter(object_.Geolocation, GeolocationAdapter)
-    converter.register_adapter(object_.MonetaryAccountReference, MonetaryAccountReferenceAdapter)
-    converter.register_adapter(object_.ShareDetail, ShareDetailAdapter)
+    converter.register_adapter(Geolocation, GeolocationAdapter)
+    converter.register_adapter(MonetaryAccountReference, MonetaryAccountReferenceAdapter)
+    converter.register_adapter(ShareDetail, ShareDetailAdapter)
     converter.register_adapter(datetime.datetime, DateTimeAdapter)
     converter.register_adapter(Pagination, PaginationAdapter)
 

bunq/sdk/context/api_context.py

@@ -12,8 +12,7 @@
 from bunq.sdk.exception.bunq_exception import BunqException
 from bunq.sdk.json import converter
 from bunq.sdk.model.core.payment_service_provider_credential_internal import PaymentServiceProviderCredentialInternal
-from bunq.sdk.model.generated import endpoint
-from bunq.sdk.model.generated.endpoint import UserCredentialPasswordIp
+from bunq.sdk.model.generated.endpoint import UserCredentialPasswordIp, Session
 from bunq.sdk.security import security
 
 if typing.TYPE_CHECKING:
@@ -221,7 +220,7 @@ def close_session(self) -> None:
         self._drop_session_context()
 
     def _delete_session(self) -> None:
-        endpoint.Session.delete(self._SESSION_ID_DUMMY)
+        Session.delete(self._SESSION_ID_DUMMY)
 
     @property
     def environment_type(self) -> ApiEnvironmentType:

bunq/sdk/context/user_context.py

@@ -1,8 +1,7 @@
-from bunq import T
 from bunq.sdk.exception.bunq_exception import BunqException
 from bunq.sdk.model.core.bunq_model import BunqModel
-from bunq.sdk.model.generated import endpoint
-from bunq.sdk.model.generated.endpoint import UserPerson, UserCompany, UserApiKey, MonetaryAccountBank
+from bunq.sdk.model.generated.endpoint import UserPerson, UserCompany, UserApiKey, MonetaryAccountBank, User, \
+    UserPaymentServiceProvider
 
 
 class UserContext:
@@ -22,19 +21,19 @@ def __init__(self, user_id: int, user: BunqModel) -> None:
 
     @staticmethod
     def __get_user_object() -> BunqModel:
-        return endpoint.User.list().value[0].get_referenced_object()
+        return User.list().value[0].get_referenced_object()
 
     def _set_user(self, user: BunqModel) -> None:
-        if isinstance(user, endpoint.UserPerson):
+        if isinstance(user, UserPerson):
             self._user_person = user
 
-        elif isinstance(user, endpoint.UserCompany):
+        elif isinstance(user, UserCompany):
             self._user_company = user
 
-        elif isinstance(user, endpoint.UserApiKey):
+        elif isinstance(user, UserApiKey):
             self._user_api_key = user
 
-        elif isinstance(user, endpoint.UserPaymentServiceProvider):
+        elif isinstance(user, UserPaymentServiceProvider):
             self._user_payment_service_provider = user
 
         else:
@@ -45,7 +44,7 @@ def init_main_monetary_account(self) -> None:
         if self._user_payment_service_provider is not None:
             return
 
-        all_monetary_account = endpoint.MonetaryAccountBank.list().value
+        all_monetary_account = MonetaryAccountBank.list().value
 
         for account in all_monetary_account:
             if account.status == self._STATUS_ACTIVE:

bunq/sdk/json/monetary_account_reference_adapter.py

@@ -1,19 +1,15 @@
 from typing import Type, Dict
 
 from bunq.sdk.json import converter
-from bunq.sdk.model.generated import object_
-from bunq.sdk.model.generated.object_ import MonetaryAccountReference
+from bunq.sdk.model.generated.object_ import MonetaryAccountReference, LabelMonetaryAccount
 
 
 class MonetaryAccountReferenceAdapter(converter.JsonAdapter):
     @classmethod
     def deserialize(cls,
                     target_class: Type[MonetaryAccountReference],
                     obj: Dict) -> MonetaryAccountReference:
-        label_monetary_account = converter.deserialize(
-            object_.LabelMonetaryAccount,
-            obj
-        )
+        label_monetary_account = converter.deserialize(LabelMonetaryAccount, obj)
 
         return target_class.create_from_label_monetary_account(label_monetary_account)
 

bunq/sdk/json/session_server_adapter.py

@@ -5,7 +5,7 @@
 from bunq.sdk.model.core.id import Id
 from bunq.sdk.model.core.session_server import SessionServer
 from bunq.sdk.model.core.session_token import SessionToken
-from bunq.sdk.model.generated import endpoint
+from bunq.sdk.model.generated.endpoint import UserCompany, UserPerson, UserApiKey, UserPaymentServiceProvider
 
 
 class SessionServerAdapter(converter.JsonAdapter):
@@ -65,25 +65,25 @@ def deserialize(cls,
         if cls._FIELD_USER_COMPANY in user_dict_wrapped:
             session_server.__dict__[cls._ATTRIBUTE_USER_COMPANY] = \
                 converter.deserialize(
-                    endpoint.UserCompany,
+                    UserCompany,
                     user_dict_wrapped[cls._FIELD_USER_COMPANY]
                 )
         elif cls._FIELD_USER_PERSON in user_dict_wrapped:
             session_server.__dict__[cls._ATTRIBUTE_USER_PERSON] = \
                 converter.deserialize(
-                    endpoint.UserPerson,
+                    UserPerson,
                     user_dict_wrapped[cls._FIELD_USER_PERSON]
                 )
         elif cls._FIELD_USER_API_KEY in user_dict_wrapped:
             session_server.__dict__[cls._ATTRIBUTE_USER_API_KEY] = \
                 converter.deserialize(
-                    endpoint.UserApiKey,
+                    UserApiKey,
                     user_dict_wrapped[cls._FIELD_USER_API_KEY]
                 )
         elif cls._FIELD_USER_PAYMENT_SERVER_PROVIDER in user_dict_wrapped:
             session_server.__dict__[cls._ATTRIBUTE_USER_PAYMENT_SERVER_PROVIDER] = \
                 converter.deserialize(
-                    endpoint.UserPaymentServiceProvider,
+                    UserPaymentServiceProvider,
                     user_dict_wrapped[cls._FIELD_USER_PAYMENT_SERVER_PROVIDER]
                 )
         else:

bunq/sdk/json/share_detail_adapter.py

@@ -1,8 +1,8 @@
 from typing import Dict, Type, Optional
 
 from bunq.sdk.json import converter
-from bunq.sdk.model.generated import object_
-from bunq.sdk.model.generated.object_ import ShareDetail
+from bunq.sdk.model.generated.object_ import ShareDetail, ShareDetailPayment, ShareDetailReadOnly, \
+    ShareDetailDraftPayment
 
 
 class ShareDetailAdapter(converter.JsonAdapter):
@@ -21,24 +21,24 @@ def deserialize(cls,
                     target_class: Type[ShareDetail],
                     obj: Dict) -> ShareDetail:
         """
-        :type target_class: object_.ShareDetail|type
+        :type target_class: ShareDetail|type
         :type obj: dict
 
-        :rtype: object_.ShareDetail
+        :rtype: ShareDetail
         """
 
         share_detail = target_class.__new__(target_class)
         share_detail.__dict__ = {
             cls._ATTRIBUTE_PAYMENT: converter.deserialize(
-                object_.ShareDetailPayment,
+                ShareDetailPayment,
                 cls._get_field_or_none(cls._FIELD_DRAFT_PAYMENT, obj)
             ),
             cls._ATTRIBUTE_READ_ONLY: converter.deserialize(
-                object_.ShareDetailReadOnly,
+                ShareDetailReadOnly,
                 cls._get_field_or_none(cls._FIELD_READ_ONLY, obj)
             ),
             cls._ATTRIBUTE_DRAFT_PAYMENT: converter.deserialize(
-                object_.ShareDetailDraftPayment,
+                ShareDetailDraftPayment,
                 cls._get_field_or_none(cls._FIELD_DRAFT_PAYMENT, obj)
             ),
         }

bunq/sdk/model/core/bunq_model.py

@@ -3,7 +3,7 @@
 import typing
 from typing import Dict, List
 
-from bunq import T
+from bunq.sdk.util.type_alias import T
 from bunq.sdk.http.bunq_response import BunqResponse
 from bunq.sdk.http.bunq_response_raw import BunqResponseRaw
 from bunq.sdk.json import converter

bunq/sdk/util/util.py

@@ -9,13 +9,13 @@
 from bunq.sdk.exception.bunq_exception import BunqException
 from bunq.sdk.http.api_client import ApiClient
 from bunq.sdk.model.generated import endpoint
-from bunq.sdk.model.generated.endpoint import SandboxUser
+from bunq.sdk.model.generated.endpoint import SandboxUserPerson
 
 __UNIQUE_REQUEST_ID = "uniqueness-is-required"
 __FIELD_API_KEY = "ApiKey"
 __INDEX_FIRST = 0
 __FIELD_RESPONSE = "Response"
-__ENDPOINT_SANDBOX_USER = "sandbox-user"
+__ENDPOINT_SANDBOX_USER_PERSON = "sandbox-user-person"
 
 _ERROR_COULD_NOT_CREATE_NEW_SANDBOX_USER = "Could not create new sandbox user."
 
@@ -29,8 +29,8 @@ def automatic_sandbox_install() -> ApiContext:
                              )
 
 
-def __generate_new_sandbox_user() -> SandboxUser:
-    url = ApiEnvironmentType.SANDBOX.uri_base + __ENDPOINT_SANDBOX_USER
+def __generate_new_sandbox_user() -> SandboxUserPerson:
+    url = ApiEnvironmentType.SANDBOX.uri_base + __ENDPOINT_SANDBOX_USER_PERSON
 
     headers = {
         ApiClient.HEADER_REQUEST_ID: __UNIQUE_REQUEST_ID,
@@ -44,7 +44,7 @@ def __generate_new_sandbox_user() -> SandboxUser:
 
     if response.status_code is ApiClient.STATUS_CODE_OK:
         response_json = json.loads(response.text)
-        return endpoint.SandboxUser.from_json(
+        return SandboxUserPerson.from_json(
             json.dumps(response_json[__FIELD_RESPONSE][__INDEX_FIRST][
                            __FIELD_API_KEY]))
 

setup.py

@@ -62,7 +62,7 @@
     ],
 
     # Require Python version equal or higher than the requested version.
-    python_requires='>=3.5.3',
+    python_requires='>=3.7.0',
 
     # Keywords related to the project
     keywords='open-banking sepa bunq finance api payment',