Added support for user api key. (#102)

Author: Kevin Hellemun

bunq/sdk/context.py

@@ -137,7 +137,7 @@ def _initialize_session(self):
         session_server = core.SessionServer.create(self).value
         token = session_server.token.token
         expiry_time = self._get_expiry_timestamp(session_server)
-        user_id = session_server.get_referenced_object().id_
+        user_id = session_server.get_referenced_user().id_
 
         self._session_context = SessionContext(token, expiry_time, user_id)
 
@@ -164,8 +164,16 @@ def _get_session_timeout_seconds(cls, session_server):
 
         if session_server.user_company is not None:
             return session_server.user_company.session_timeout
-        else:
+        elif session_server.user_person is not None:
             return session_server.user_person.session_timeout
+        elif session_server.user_api_key is not None:
+            return session_server \
+                .user_api_key \
+                .requested_by_user \
+                .get_referenced_object() \
+                .session_timeout
+        else:
+            raise BunqException()
 
     def ensure_session_active(self) -> bool:
         """
@@ -433,6 +441,7 @@ def __init__(self, user_id):
         self._user_id = user_id
         self._user_person = None
         self._user_company = None
+        self._user_api_key = None
         self._primary_monetary_account = None
 
         self._set_user(self.__get_user_object())
@@ -452,6 +461,9 @@ def _set_user(self, user):
         elif isinstance(user, endpoint.UserCompany):
             self._user_company = user
 
+        elif isinstance(user, endpoint.UserApiKey):
+            self._user_api_key = user
+
         else:
             raise BunqException(
                 self._ERROR_UNEXPECTED_USER_INSTANCE.format(user.__class__))
@@ -476,21 +488,36 @@ def is_only_user_person_set(self):
         :rtype: bool
         """
 
-        return self._user_person is not None and self._user_company is None
+        return self._user_person is not None \
+            and self._user_company is None \
+            and self._user_api_key is None
 
     def is_only_user_company_set(self):
         """
         :rtype: bool
         """
 
-        return self._user_company is not None and self._user_person is None
+        return self._user_company is not None \
+            and self._user_person is None \
+            and self._user_api_key is None
 
-    def is_both_user_type_set(self):
+    def is_only_user_api_key_set(self):
         """
         :rtype: bool
         """
 
-        return self._user_company is not None and self._user_person is not None
+        return self._user_api_key is not None \
+            and self._user_company is None \
+            and self._user_person is None
+
+    def is_all_user_type_set(self):
+        """
+        :rtype: bool
+        """
+
+        return self._user_company is not None \
+            and self._user_person is not None \
+            and self._user_api_key is not None
 
     def refresh_user_context(self):
         """
@@ -515,6 +542,14 @@ def user_person(self):
 
         return self._user_person
 
+    @property
+    def user_api_key(self):
+        """
+        :rtype: endpoint.UserApiKey
+        """
+
+        return self._user_api_key
+
     @property
     def primary_monetary_account(self):
         """

bunq/sdk/json/adapters.py

@@ -161,6 +161,10 @@ class SessionServerAdapter(converter.JsonAdapter):
     _ATTRIBUTE_USER_PERSON = '_user_person'
     _FIELD_USER_PERSON = 'UserPerson'
 
+    # UserApiKey constants
+    _ATTRIBUTE_USER_API_KEY = '_user_api_key'
+    _FIELD_USER_API_KEY = 'UserApiKey'
+
     @classmethod
     def deserialize(cls, target_class, array):
         """
@@ -198,6 +202,14 @@ def deserialize(cls, target_class, array):
                     endpoint.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,
+                user_dict_wrapped[cls._FIELD_USER_API_KEY]
+            )
+        else:
+            raise BunqException('Could not determine user.')
 
         return session_server
 
@@ -220,6 +232,10 @@ def serialize(cls, session_server):
                 cls._FIELD_USER_PERSON:
                     converter.serialize(session_server.user_person),
             },
+            {
+                cls._FIELD_USER_API_KEY:
+                    converter.serialize(session_server.user_api_key),
+            },
         ]
 
 

bunq/sdk/model/core.py

@@ -403,6 +403,7 @@ class SessionServer(BunqModel):
     :type _token: SessionToken
     :type _user_person: bunq.sdk.model.generated.UserPerson
     :type _user_company: bunq.sdk.model.generated.UserCompany
+    :type _user_api_key: bunq.sdk.model.generated.UserApiKey
     """
 
     # Endpoint name.
@@ -419,6 +420,7 @@ def __init__(self):
         self._token = None
         self._user_person = None
         self._user_company = None
+        self._user_api_key = None
 
     @property
     def id_(self):
@@ -452,6 +454,14 @@ def user_company(self):
 
         return self._user_company
 
+    @property
+    def user_api_key(self):
+        """
+        :rtype: bunq.sdk.model.generated.UserApiKey
+        """
+
+        return self._user_api_key
+
     @classmethod
     def create(cls, api_context):
         """
@@ -489,9 +499,12 @@ def is_all_field_none(self):
         if self.user_company is not None:
             return False
 
+        if self.user_api_key is not None:
+            return False
+
         return True
 
-    def get_referenced_object(self):
+    def get_referenced_user(self):
         """
         :rtype: BunqModel
         """
@@ -502,4 +515,7 @@ def get_referenced_object(self):
         if self._user_company is not None:
             return self._user_company
 
+        if self._user_api_key is not None:
+            return self._user_api_key
+
         raise BunqException(self._ERROR_ALL_FIELD_IS_NULL)