Merge pull request #168 from WinkPascal/develop

bunq Update 28 | Update object naming, fix parsing and fix tests

Author: andrederoos

.gitignore

@@ -6,30 +6,11 @@
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff:
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/dictionaries
-.idea/shelf
-
-# Sensitive or high-churn files:
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.xml
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-
-# Gradle:
-.idea/**/gradle.xml
-.idea/**/libraries
+.idea
 
 # CMake
 cmake-build-debug/
 
-# Mongo Explorer plugin:
-.idea/**/mongoSettings.xml
-
 ## File-based project format:
 *.iws
 
@@ -97,3 +78,9 @@ connectQr.png
 bunq_sdk.egg-info
 .idea/codeStyles/
 venv
+
+tests/bunq-oauth-psd2-test.conf
+tests/bunq-psd2-test.conf
+tests/key.pem
+tests/certificate.pem
+

README.md

@@ -1,148 +1 @@
-# bunq Python SDK
-
-## Introduction
-Hi developers!
-
-Welcome to the bunq Python SDK! 👨‍💻
-
-We're very happy to introduce yet another unique product: complete banking SDKs! 
-Now you can build even bigger and better apps and integrate them with your bank of the free! 🌈
-
-Before you dive into this brand new SDK, please consider:
-- Learning how bunq works and what objects you will work with by reading [the intro to our API](https://github.com/bunq/doc/blob/develop/README.md) 🤓
-- Checking out [our developer portal](https://developer.bunq.com/) 🙌  
-- Grabbing your Production API key from [our developer portal](https://developer.bunq.com/) or the bunq app 🗝
-- Generating a Sandbox API key using [our developer portal](https://developer.bunq.com/) or [Tinker](https://www.bunq.com/developer) 🗝
-- Visiting [our forum](https://together.bunq.com/t/api) where you can share your creations,
-questions and experience 🎤
-
-Give us your feedback, create pull requests, build your very own bunq apps and most importantly:
-have fun! 💪
-
-This SDK is in **beta**. We cannot guarantee constant availability or stability. 
-Thanks to your feedback we will make improvements on it.
-
-## Installation
-    pip install bunq_sdk --upgrade
-
-## Usage
-
-### Creating an API context
-In order to start making calls with the bunq API, you must first register your API key and device,
-and create a session. In the SDKs, we group these actions and call it "creating an API context". The
-context can be created by using the following code snippet:
-
-
-    apiContext = ApiContext.create(ENVIRONMENT_TYPE, API_KEY, DEVICE_DESCRIPTION)
-    apiContext.save(API_CONTEXT_FILE_PATH)
-
-
-**Please note**: initialising your application is a heavy task and it is recommended to do it only once per device.
-
-    apiContext = ApiContext.restore(self.API_CONTEXT_FILE_PATH)
-    BunqContext.loadApiContext(apiContext)
-
-After saving the context, you can restore it at any time: 
-
-#### Example
-
-See [`tinker/setup_context`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L44-L59)
-
-#### PSD2
-It is possible to create an ApiContext as PSD2 Service Provider. Although this might seem a complex task, we wrote some 
-helper implementations to get you started. You need to create a certificate and private key to get you started. 
-Our sandbox environment currently accepts all certificates, if these criteria are met:
-
-- Up to 64 characters
-- PISP and/or AISP used in the end.
-
-Make sure you have your unique eIDAS certificate number and certificates ready when you want to perform these tasks on 
-our production environment.
-
-Creating a PSD2 context is very easy:
-
-    apiContext = ApiContext.create_for_psd2(ENVIRONMENT_TYPE, CERTIFICATE, PRIVATE_KEY, CERTIFICATE_CHAIN, DEVICE_DESCRIPTION)
-
-#### Safety considerations
-The file storing the context details (i.e. `bunq.conf`) is a key to your account. Anyone having
-access to it is able to perform any Public API actions with your account. Therefore, we recommend
-choosing a truly safe place to store it.
-
-### Making API calls
-There is a class for each endpoint. Each class has functions for each supported action. These
-actions can be `create`, `get`, `update`, `delete` and `list`.
-
-Sometimes API calls have dependencies, for instance `MonetaryAccount`. Making changes to a monetary
-account always also needs a reference to a `User`. These dependencies are required as arguments when
-performing API calls. Take a look at [doc.bunq.com](https://doc.bunq.com) for the full
-documentation.
-
-#### Creating objects
-Creating objects through the API requires an `ApiContext`, a `requestMap` and identifiers of all
-dependencies (such as User ID required for accessing a Monetary Account). Optionally, custom headers
-can be passed to requests.
-
-    payment_id = Payment.create(
-        amount=Amount(amount_string, self._CURRENCY_EURL),
-        counterparty_alias=Pointer(self._POINTER_TYPE_EMAIL, recipient),
-        description=description
-    )
-
-##### Example
-See [`tinker/make_payment`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L140-L151)
-
-#### Reading objects
-Reading objects through the API requires an `ApiContext`, identifiers of all dependencies (such as
-User ID required for accessing a Monetary Account), and the identifier of the object to read (ID or
-UUID) Optionally, custom headers can be passed to requests.
-
-This type of calls always returns a model.
-
-    monetary_account = generated.MonetaryAccountBank.get(
-        _MONETARY_ACCOUNT_ITEM_ID
-    )
-
-##### Example
-See [`tinker/list_all_payment`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L85-L103)
-
-#### Updating objects
-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.
-
-    Card.update(
-        card_id=int(card_id),
-        monetary_account_current_id=int(account_id)
-    )
-
-##### Example
-See [`tinker/update_card`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L167-L174)
-
-#### Deleting objects
-Deleting objects through the API requires an `ApiContext`, identifiers of all dependencies (such as User ID required for
-accessing a Monetary Account), and the identifier of the object to delete (ID or UUID) Optionally, custom headers can be
-passed to requests.
-
-    Session.delete(self._SESSION_ID)
-
-##### Example
-
-#### Listing objects
-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 = User.list(api_context)
-
-##### Example
-See [`UserListExample.py`](./examples/user_list_example.py)
-
-## Running Samples
-To get an indication on how the SDK works you can use the python tinker which is located at https://github.com/bunq/tinker_python
-
-## Running Tests
-
-Information regarding the test cases can be found in the [README.md](./tests/README.md)
-located in [test](/tests).
-
-## Exceptions
-The SDK can raise multiple exceptions. For an overview of these exceptions please
-take a look at [EXCEPTIONS.md](./bunq/sdk/exception/EXCEPTIONS.md).
+📚 For full documentation about this sdk, visit [doc.bunq.com](https://doc.bunq.com/getting-started/tools/software-development-kits-sdks/python/usage).

bunq/__init__.py

@@ -5,7 +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.model.generated.object_ import GeolocationObject, ShareDetailObject, MonetaryAccountReference
 from bunq.sdk.util.type_alias import T
 
 
@@ -37,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(Geolocation, GeolocationAdapter)
+    converter.register_adapter(GeolocationObject, GeolocationAdapter)
     converter.register_adapter(MonetaryAccountReference, MonetaryAccountReferenceAdapter)
-    converter.register_adapter(ShareDetail, ShareDetailAdapter)
+    converter.register_adapter(ShareDetailObject, ShareDetailAdapter)
     converter.register_adapter(datetime.datetime, DateTimeAdapter)
     converter.register_adapter(Pagination, PaginationAdapter)
 

bunq/sdk/context/api_context.py

@@ -12,7 +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.endpoint import UserCredentialPasswordIp, Session
+from bunq.sdk.model.generated.endpoint import UserCredentialPasswordIpApiObject, SessionApiObject
 from bunq.sdk.security import security
 
 if typing.TYPE_CHECKING:
@@ -115,7 +115,7 @@ def __initialize_installation(self) -> None:
     def __initialize_psd2_credential(self,
                                      certificate: str,
                                      private_key: str,
-                                     all_chain_certificate: List[str]) -> UserCredentialPasswordIp:
+                                     all_chain_certificate: List[str]) -> UserCredentialPasswordIpApiObject:
         session_token = self.installation_context.token
         client_key_pair = self.installation_context.private_key_client
 

bunq/sdk/context/session_context.py

@@ -6,18 +6,18 @@
 from bunq.sdk.exception.bunq_exception import BunqException
 from bunq.sdk.model.core.bunq_model import BunqModel
 from bunq.sdk.model.core.session_token import SessionToken
-from bunq.sdk.model.generated.endpoint import UserPerson, UserCompany, UserApiKey, UserPaymentServiceProvider
+from bunq.sdk.model.generated.endpoint import UserPersonApiObject, UserCompanyApiObject, UserApiKeyApiObject, UserPaymentServiceProviderApiObject
 
 
 class SessionContext:
     """
     :type _token: str
     :type _expiry_time: datetime.datetime
     :type _user_id: int
-    :type _user_person: UserPerson|None
-    :type _user_company: UserCompany|None
-    :type _user_api_key: UserApiKey|None
-    :type _user_payment_service_provider: UserPaymentServiceProvider|None
+    :type _user_person: UserPersonApiObject|None
+    :type _user_company: UserCompanyApiObject|None
+    :type _user_api_key: UserApiKeyApiObject|None
+    :type _user_payment_service_provider: UserPaymentServiceProviderApiObject|None
     """
 
     # Error constants
@@ -37,19 +37,19 @@ def user_id(self) -> int:
         return self._user_id
 
     @property
-    def user_person(self) -> Optional[UserPerson]:
+    def user_person(self) -> Optional[UserPersonApiObject]:
         return self._user_person
 
     @property
-    def user_company(self) -> Optional[UserCompany]:
+    def user_company(self) -> Optional[UserCompanyApiObject]:
         return self._user_company
 
     @property
-    def user_api_key(self) -> Optional[UserApiKey]:
+    def user_api_key(self) -> Optional[UserApiKeyApiObject]:
         return self._user_api_key
 
     @property
-    def user_payment_service_provider(self) -> Optional[UserPaymentServiceProvider]:
+    def user_payment_service_provider(self) -> Optional[UserPaymentServiceProviderApiObject]:
         return self._user_payment_service_provider
 
     def __init__(self, token: SessionToken, expiry_time: datetime.datetime, user: BunqModel) -> None:
@@ -63,28 +63,28 @@ def __init__(self, token: SessionToken, expiry_time: datetime.datetime, user: Bu
         self.__set_user(user)
 
     def __get_user_id(self, user: BunqModel) -> int:
-        if isinstance(user, UserPerson):
+        if isinstance(user, UserPersonApiObject):
             return user.id_
 
-        if isinstance(user, UserCompany):
+        if isinstance(user, UserCompanyApiObject):
             return user.id_
 
-        if isinstance(user, UserApiKey):
+        if isinstance(user, UserApiKeyApiObject):
             return user.id_
 
-        if isinstance(user, UserPaymentServiceProvider):
+        if isinstance(user, UserPaymentServiceProviderApiObject):
             return user.id_
 
         raise BunqException(self._ERROR_UNEXPECTED_USER_INSTANCE)
 
     def __set_user(self, user: BunqModel):
-        if isinstance(user, UserPerson):
+        if isinstance(user, UserPersonApiObject):
             self._user_person = user
-        elif isinstance(user, UserCompany):
+        elif isinstance(user, UserCompanyApiObject):
             self._user_company = user
-        elif isinstance(user, UserApiKey):
+        elif isinstance(user, UserApiKeyApiObject):
             self._user_api_key = user
-        elif isinstance(user, UserPaymentServiceProvider):
+        elif isinstance(user, UserPaymentServiceProviderApiObject):
             self._user_payment_service_provider = user
         else:
             raise BunqException(self._ERROR_UNEXPECTED_USER_INSTANCE)

bunq/sdk/context/user_context.py

@@ -1,7 +1,7 @@
 from bunq.sdk.exception.bunq_exception import BunqException
 from bunq.sdk.model.core.bunq_model import BunqModel
-from bunq.sdk.model.generated.endpoint import UserPerson, UserCompany, UserApiKey, MonetaryAccountBank, User, \
-    UserPaymentServiceProvider
+from bunq.sdk.model.generated.endpoint import UserPersonApiObject, UserCompanyApiObject, UserApiKeyApiObject, MonetaryAccountBankApiObject, UserApiObject, \
+    UserPaymentServiceProviderApiObject
 
 
 class UserContext:
@@ -21,19 +21,19 @@ def __init__(self, user_id: int, user: BunqModel) -> None:
 
     @staticmethod
     def __get_user_object() -> BunqModel:
-        return User.list().value[0].get_referenced_object()
+        return UserApiObject.list().value[0].get_referenced_object()
 
     def _set_user(self, user: BunqModel) -> None:
-        if isinstance(user, UserPerson):
+        if isinstance(user, UserPersonApiObject):
             self._user_person = user
 
-        elif isinstance(user, UserCompany):
+        elif isinstance(user, UserCompanyApiObject):
             self._user_company = user
 
-        elif isinstance(user, UserApiKey):
+        elif isinstance(user, UserApiKeyApiObject):
             self._user_api_key = user
 
-        elif isinstance(user, UserPaymentServiceProvider):
+        elif isinstance(user, UserPaymentServiceProviderApiObject):
             self._user_payment_service_provider = user
 
         else:
@@ -44,7 +44,7 @@ def init_main_monetary_account(self) -> None:
         if self._user_payment_service_provider is not None:
             return
 
-        all_monetary_account = MonetaryAccountBank.list().value
+        all_monetary_account = MonetaryAccountBankApiObject.list().value
 
         for account in all_monetary_account:
             if account.status == self._STATUS_ACTIVE:
@@ -87,17 +87,17 @@ def refresh_user_context(self) -> None:
         self.init_main_monetary_account()
 
     @property
-    def user_company(self) -> UserCompany:
+    def user_company(self) -> UserCompanyApiObject:
         return self._user_company
 
     @property
-    def user_person(self) -> UserPerson:
+    def user_person(self) -> UserPersonApiObject:
         return self._user_person
 
     @property
-    def user_api_key(self) -> UserApiKey:
+    def user_api_key(self) -> UserApiKeyApiObject:
         return self._user_api_key
 
     @property
-    def primary_monetary_account(self) -> MonetaryAccountBank:
+    def primary_monetary_account(self) -> MonetaryAccountBankApiObject:
         return self._primary_monetary_account