Merge pull request #356 from rubenhesselink/add-terminals

Add terminal object and resource

Author: geertjanvdenbosch

mollie/api/client.py

@@ -28,6 +28,7 @@
     Refunds,
     Settlements,
     Subscriptions,
+    Terminals,
 )
 from .version import VERSION
 
@@ -107,6 +108,7 @@ def __init__(self, api_endpoint: str = "", timeout: Union[int, Tuple[int, int]]
         self.settlements = Settlements(self)
         self.subscriptions = Subscriptions(self)
         self.balances = Balances(self)
+        self.terminals = Terminals(self)
 
         # compose base user agent string
         self.user_agent_components = OrderedDict()

mollie/api/objects/terminal.py

@@ -0,0 +1,39 @@
+from .base import ObjectBase
+
+
+class Terminal(ObjectBase):
+    @property
+    def id(self):
+        return self._get_property("id")
+
+    @property
+    def status(self):
+        return self._get_property("status")
+
+    @property
+    def brand(self):
+        return self._get_property("brand")
+
+    @property
+    def model(self):
+        return self._get_property("model")
+
+    @property
+    def serial_number(self):
+        return self._get_property("serialNumber")
+
+    @property
+    def currency(self):
+        return self._get_property("currency")
+
+    @property
+    def description(self):
+        return self._get_property("description")
+
+    @property
+    def profile_id(self):
+        return self._get_property("profileId")
+
+    @property
+    def created_at(self):
+        return self._get_property("createdAt")

mollie/api/resources/__init__.py

@@ -18,3 +18,4 @@
 from .settlements import *  # noqa: F401, F403
 from .shipments import *  # noqa: F401, F403
 from .subscriptions import *  # noqa: F401, F403
+from .terminals import *  # noqa: F401, F403

mollie/api/resources/terminals.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+from ..objects.terminal import Terminal
+from .base import ResourceGetMixin, ResourceListMixin
+
+__all__ = [
+    "Terminals",
+]
+
+
+class Terminals(ResourceGetMixin, ResourceListMixin):
+    """
+    Resource handler for the `/terminals` endpoint.
+
+    Retrieve either a single or a list of terminals.
+    """
+
+    RESOURCE_ID_PREFIX: str = "term_"
+    object_type = Terminal
+
+    def get(self, resource_id: str, **params: Any) -> Terminal:
+        """Retrieve a single terminal, by its ID."""
+        self.validate_resource_id(resource_id, "terminal ID")
+        return super().get(resource_id, **params)

tests/responses/terminal_single.json

@@ -0,0 +1,22 @@
+{
+  "resource": "terminal",
+  "id": "term_7MgL4wea46qkRcoTZjWEH",
+  "status": "active",
+  "brand": "PAX",
+  "model": "A920",
+  "serialNumber": "1234567890",
+  "currency": "EUR",
+  "description": "Terminal #12345",
+  "profileId": "pfl_QkEhN94Ba",
+  "createdAt": "2022-02-12T11:58:35+00:00",
+  "_links": {
+    "self": {
+      "href": "...",
+      "type": "application/hal+json"
+    },
+    "documentation": {
+      "href": "...",
+      "type": "text/html"
+    }
+  }
+}

tests/responses/terminals_list.json

@@ -0,0 +1,73 @@
+{
+  "count": 3,
+  "_embedded": {
+    "terminals": [
+      {
+        "resource": "terminal",
+        "id": "term_7MgL4wea46qkRcoTZjWEH",
+        "status": "active",
+        "brand": "PAX",
+        "model": "A920",
+        "serialNumber": "1234567890",
+        "currency": "EUR",
+        "description": "Terminal #12345",
+        "profileId": "pfl_QkEhN94Ba",
+        "createdAt": "2022-02-12T11:58:35+00:00",
+        "_links": {
+          "self": {
+            "href": "...",
+            "type": "application/hal+json"
+          }
+        }
+      },
+      {
+        "resource": "terminal",
+        "id": "term_8MgL4wea46qkRcoTZjWEH",
+        "status": "active",
+        "brand": "PAX",
+        "model": "A920",
+        "serialNumber": "1234567890",
+        "currency": "EUR",
+        "description": "Terminal #12345",
+        "profileId": "pfl_QkEhN94Ba",
+        "createdAt": "2022-02-12T11:58:35+00:00",
+        "_links": {
+          "self": {
+            "href": "...",
+            "type": "application/hal+json"
+          }
+        }
+      },
+      {
+        "resource": "terminal",
+        "id": "term_9MgL4wea46qkRcoTZjWEH",
+        "status": "active",
+        "brand": "PAX",
+        "model": "A920",
+        "serialNumber": "1234567890",
+        "currency": "EUR",
+        "description": "Terminal #12345",
+        "profileId": "pfl_QkEhN94Ba",
+        "createdAt": "2022-02-12T11:58:35+00:00",
+        "_links": {
+          "self": {
+            "href": "...",
+            "type": "application/hal+json"
+          }
+        }
+      }
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "...",
+      "type": "application/hal+json"
+    },
+    "previous": null,
+    "next": null,
+    "documentation": {
+      "href": "...",
+      "type": "text/html"
+    }
+  }
+}

tests/test_terminals.py

@@ -0,0 +1,20 @@
+from mollie.api.objects.terminal import Terminal
+
+from .utils import assert_list_object
+
+TERMINAL_ID = "term_7MgL4wea46qkRcoTZjWEH"
+
+
+def test_get_terminal(client, response):
+    response.get(f"https://api.mollie.com/v2/terminals/{TERMINAL_ID}", "terminal_single")
+
+    terminal = client.terminals.get(TERMINAL_ID)
+
+    assert terminal.id == TERMINAL_ID
+
+
+def test_list_terminals(client, response):
+    response.get("https://api.mollie.com/v2/terminals", "terminals_list")
+
+    terminals = client.terminals.list()
+    assert_list_object(terminals, Terminal)