cleanup Pagination and payment list example [#20]

Author: dnl-blkv

bunq/sdk/client.py

@@ -52,8 +52,8 @@ class ApiClient(object):
     _METHOD_GET = 'GET'
     _METHOD_DELETE = 'DELETE'
 
-    # Delimiter between path and params in URI
-    _DELIMITER_PATH_AND_PARAMS = '?'
+    # Delimiter between path and params in URL
+    _DELIMITER_URL_QUERY = '?'
 
     # Status code for successful execution
     _STATUS_CODE_OK = 200
@@ -140,7 +140,7 @@ def _append_params_to_uri(cls, uri, params):
         """
 
         if params:
-            return uri + cls._DELIMITER_PATH_AND_PARAMS + urlencode(params)
+            return uri + cls._DELIMITER_URL_QUERY + urlencode(params)
 
         return uri
 
@@ -343,13 +343,14 @@ class BunqResponse(object):
     """
     :type _value: T
     :type _headers: dict[str, str]
-    :type _pagination: Pagination
+    :type _pagination: Pagination|None
     """
 
     def __init__(self, value, headers, pagination=None):
         """
         :type value: T
         :type headers: dict[str, str]
+        :type pagination Pagination|None
         """
 
         self._value = value
@@ -394,9 +395,9 @@ class Pagination(object):
                               'there is no previous page.'
 
     # URL Param constants
-    URL_PARAM_OLDER_ID = 'older_id'
-    URL_PARAM_NEWER_ID = 'newer_id'
-    URL_PARAM_COUNT = 'count'
+    PARAM_OLDER_ID = 'older_id'
+    PARAM_NEWER_ID = 'newer_id'
+    PARAM_COUNT = 'count'
 
     def __init__(self):
         self.older_id = None
@@ -414,9 +415,7 @@ def url_params_previous_page(self):
         if not self.has_previous_item():
             raise exception.BunqException(self._ERROR_NO_PREVIOUS_PAGE)
 
-        params = {
-            self.URL_PARAM_OLDER_ID: str(self.older_id),
-        }
+        params = {self.PARAM_OLDER_ID: str(self.older_id)}
         self._add_count_to_params_if_needed(params)
 
         return params
@@ -447,7 +446,7 @@ def _add_count_to_params_if_needed(self, params):
         """
 
         if self.count is not None:
-            params[self.URL_PARAM_COUNT] = str(self.count)
+            params[self.PARAM_COUNT] = str(self.count)
 
     @property
     def _next_id(self):
@@ -473,9 +472,7 @@ def url_params_next_page(self):
         :rtype: dict[str, str]
         """
 
-        params = {
-            self.URL_PARAM_NEWER_ID: str(self._next_id),
-        }
+        params = {self.PARAM_NEWER_ID: str(self._next_id)}
         self._add_count_to_params_if_needed(params)
 
         return params

bunq/sdk/json/adapters.py

@@ -490,21 +490,21 @@ def parse_pagination_dict(cls, response_obj):
             cls._FIELD_OLDER_ID,
             response_obj,
             cls._FIELD_OLDER_URL,
-            client.Pagination.URL_PARAM_OLDER_ID
+            client.Pagination.PARAM_OLDER_ID
         )
         cls.update_dict_id_field_from_response_field(
             pagination_dict,
             cls._FIELD_NEWER_ID,
             response_obj,
             cls._FIELD_NEWER_URL,
-            client.Pagination.URL_PARAM_NEWER_ID
+            client.Pagination.PARAM_NEWER_ID
         )
         cls.update_dict_id_field_from_response_field(
             pagination_dict,
             cls._FIELD_FUTURE_ID,
             response_obj,
             cls._FIELD_FUTURE_URL,
-            client.Pagination.URL_PARAM_NEWER_ID
+            client.Pagination.PARAM_NEWER_ID
         )
 
         return pagination_dict
@@ -530,10 +530,9 @@ def update_dict_id_field_from_response_field(cls, dict_, dict_id_field,
                 parameters[response_param][cls._INDEX_FIRST]
             )
 
-            if cls._FIELD_COUNT in parameters:
+            if cls._FIELD_COUNT in parameters and cls._FIELD_COUNT not in dict_:
                 dict_[cls._FIELD_COUNT] = int(
-                    parameters[client.Pagination.URL_PARAM_COUNT][
-                        cls._INDEX_FIRST]
+                    parameters[client.Pagination.PARAM_COUNT][cls._INDEX_FIRST]
                 )
 
     @classmethod

bunq/sdk/model/generated/endpoint.py

@@ -9195,7 +9195,6 @@ class UserCompany(model.BunqModel):
     FIELD_NAME = "name"
     FIELD_PUBLIC_NICK_NAME = "public_nick_name"
     FIELD_AVATAR_UUID = "avatar_uuid"
-    FIELD_ADDRESS = "address"
     FIELD_ADDRESS_MAIN = "address_main"
     FIELD_ADDRESS_POSTAL = "address_postal"
     FIELD_LANGUAGE = "language"
@@ -10035,7 +10034,6 @@ class UserPerson(model.BunqModel):
     FIELD_MIDDLE_NAME = "middle_name"
     FIELD_LAST_NAME = "last_name"
     FIELD_PUBLIC_NICK_NAME = "public_nick_name"
-    FIELD_ADDRESS = "address"
     FIELD_ADDRESS_MAIN = "address_main"
     FIELD_ADDRESS_POSTAL = "address_postal"
     FIELD_AVATAR_UUID = "avatar_uuid"
@@ -10532,7 +10530,6 @@ class UserLight(model.BunqModel):
     FIELD_LAST_NAME = "last_name"
     FIELD_PUBLIC_NICK_NAME = "public_nick_name"
     FIELD_COUNTER_BANK_IBAN = "counter_bank_iban"
-    FIELD_ADDRESS = "address"
     FIELD_ADDRESS_MAIN = "address_main"
     FIELD_ADDRESS_POSTAL = "address_postal"
     FIELD_AVATAR_UUID = "avatar_uuid"

examples/payment_list_example.py

@@ -7,12 +7,13 @@
 # Console messages
 _MESSAGE_LATEST_PAGE_IDS = 'Latest page IDs:'
 _MESSAGE_SECOND_LATEST_PAGE_IDS = 'Second latest page IDs:'
+_MESSAGE_NO_PRIOR_PAYMENTS_FOUND = 'No prior payments found!'
 
 # Size of page of payments to list
 _PAGE_SIZE = 3
 
-_USER_ITEM_ID = 0  # Put your user ID here
-_MONETARY_ACCOUNT_ITEM_ID = 0  # Put your monetary account ID here
+_USER_ITEM_ID = 1969  # Put your user ID here
+_MONETARY_ACCOUNT_ITEM_ID = 1988  # Put your monetary account ID here
 
 
 def run():
@@ -31,14 +32,16 @@ def run():
     for payment in payments_response.value:
         print(payment.id_)
 
-    payments_response_previous = generated.Payment.list(
-        api_context,
-        _USER_ITEM_ID,
-        _MONETARY_ACCOUNT_ITEM_ID,
-        payments_response.pagination.url_params_previous_page
-    )
-
-    print(_MESSAGE_SECOND_LATEST_PAGE_IDS)
-
-    for payment in payments_response_previous.value:
-        print(payment.id_)
+    if payments_response.pagination.has_previous_item():
+        print(_MESSAGE_SECOND_LATEST_PAGE_IDS)
+        payments_response_previous = generated.Payment.list(
+            api_context,
+            _USER_ITEM_ID,
+            _MONETARY_ACCOUNT_ITEM_ID,
+            payments_response.pagination.url_params_previous_page
+        )
+
+        for payment in payments_response_previous.value:
+            print(payment.id_)
+    else:
+        print(_MESSAGE_NO_PRIOR_PAYMENTS_FOUND)