♻️ organize convenience methods into separate namespace

Author: swrichards

openklant_client/_methods/__init__.py

@@ -0,0 +1,26 @@
+from typing import cast
+
+from ape_pie import APIClient
+
+from openklant_client._resources.base import ConvenienceMethodMixin
+from openklant_client.types.methods.maak_klant_contact import (
+    MaakKlantContactCreateData,
+    MaakKlantContactResponse,
+)
+
+
+class MaakKlantContactConvenienceMethod(ConvenienceMethodMixin):
+    """
+    Convenience endpoint to create of KlantContact, Betrokkene and OnderwerpObject
+    """
+
+    http_client: APIClient
+    base_path: str = "maak-klantcontact"
+
+    def __call__(
+        self,
+        *,
+        data: MaakKlantContactCreateData,
+    ) -> MaakKlantContactResponse:
+        response = self._post(self.base_path, data=data)
+        return cast(MaakKlantContactResponse, self.process_response(response))

openklant_client/_methods/maak_klant_contact.py

@@ -239,3 +239,15 @@ def inner(*args: P.args, **kwargs: P.kwargs) -> Generator[T, Any, None]:
             return self._paginator(f(*args, **kwargs))
 
         return inner
+
+
+class ConvenienceMethodMixin(ResourceMixin):
+    http_client: APIClient
+
+    def __init__(self, http_client: APIClient):
+        self.http_client = http_client
+
+    def __call__(self):
+        raise NotImplementedError(
+            "You must implement the _call__ method to invoke the convenience method"
+        )

openklant_client/_resources/base.py

@@ -1,19 +1,29 @@
+from dataclasses import dataclass
 from typing import Any
 
 from ape_pie import APIClient
 from ape_pie.typing import ConfigAdapter
 
+from openklant_client._methods.maak_klant_contact import (
+    MaakKlantContactConvenienceMethod,
+)
 from openklant_client._resources.actor import ActorResource
 from openklant_client._resources.betrokkene import BetrokkeneResource
 from openklant_client._resources.digitaal_adres import DigitaalAdresResource
 from openklant_client._resources.interne_taak import InterneTaakResource
 from openklant_client._resources.klant_contact import KlantContactResource
-from openklant_client._resources.maak_klant_contact import MaakKlantContactResource
 from openklant_client._resources.onderwerp_object import OnderwerpObjectResource
 from openklant_client._resources.partij import PartijResource
 from openklant_client._resources.partij_identificator import PartijIdentificatorResource
 
 
+@dataclass
+class ConvenienceMethods:
+    """Container for non-resource centric, convenience method endpoints."""
+
+    maak_klant_contact: MaakKlantContactConvenienceMethod
+
+
 class OpenKlantClient(APIClient):
     partij: PartijResource
     partij_identificator: PartijIdentificatorResource
@@ -23,7 +33,7 @@ class OpenKlantClient(APIClient):
     actor: ActorResource
     interne_taak: InterneTaakResource
     betrokkene: BetrokkeneResource
-    maak_klant_contact: MaakKlantContactResource
+    methods: ConvenienceMethods
 
     def __init__(
         self,
@@ -50,7 +60,9 @@ def __init__(
         self.actor = ActorResource(self)
         self.interne_taak = InterneTaakResource(self)
         self.betrokkene = BetrokkeneResource(self)
-        self.maak_klant_contact = MaakKlantContactResource(self)
+        self.methods = ConvenienceMethods(
+            maak_klant_contact=MaakKlantContactConvenienceMethod(self)
+        )
 
     @classmethod
     def configure_from(cls, adapter: ConfigAdapter, **kwargs):

openklant_client/_resources/maak_klant_contact.py

@@ -0,0 +1,26 @@
+from typing import NotRequired, TypedDict
+
+from openklant_client.types.resources.betrokkene import (
+    Betrokkene,
+    BetrokkeneBaseCreateData,
+)
+from openklant_client.types.resources.klant_contact import (
+    CreateKlantContactData,
+    KlantContact,
+)
+from openklant_client.types.resources.onderwerp_object import (
+    OnderwerpObject,
+    OnderwerpObjectBaseCreateData,
+)
+
+
+class MaakKlantContactCreateData(TypedDict):
+    klantcontact: CreateKlantContactData
+    betrokkene: NotRequired[BetrokkeneBaseCreateData]
+    onderwerpobject: NotRequired[OnderwerpObjectBaseCreateData]
+
+
+class MaakKlantContactResponse(TypedDict):
+    klantcontact: KlantContact
+    betrokkene: Betrokkene | None
+    onderwerpobject: OnderwerpObject | None

openklant_client/client.py

@@ -2,7 +2,7 @@
 
 from tests.validators import (
     MaakKlantContactCreateDataValidator,
-    MaakKlantContactValidator,
+    MaakKlantContactResponseValidator,
 )
 
 
@@ -32,6 +32,6 @@ def test_create_klant_contact(client) -> None:
             },
         }
     )
-    resp = client.maak_klant_contact.create(data=data)
+    resp = client.methods.maak_klant_contact(data=data)
 
-    MaakKlantContactValidator.validate_python(resp)
+    MaakKlantContactResponseValidator.validate_python(resp)

openklant_client/types/methods/__init__.py

@@ -8,6 +8,10 @@
 
 from pydantic import TypeAdapter
 
+from openklant_client.types.methods.maak_klant_contact import (
+    MaakKlantContactCreateData,
+    MaakKlantContactResponse,
+)
 from openklant_client.types.resources.actor import Actor, CreateActorData
 from openklant_client.types.resources.betrokkene import Betrokkene, BetrokkeneCreateData
 from openklant_client.types.resources.digitaal_adres import (
@@ -22,10 +26,6 @@
     CreateKlantContactData,
     KlantContact,
 )
-from openklant_client.types.resources.maak_klant_contact import (
-    MaakKlantContact,
-    MaakKlantContactCreateData,
-)
 from openklant_client.types.resources.onderwerp_object import (
     CreateOnderwerpObjectData,
     OnderwerpObject,
@@ -76,5 +76,5 @@
 CreatePartijIdentificatorDataValidator = TypeAdapter(CreatePartijIdentificatorData)
 
 #  Maak Klant Contact validators
-MaakKlantContactValidator = TypeAdapter(MaakKlantContact)
+MaakKlantContactResponseValidator = TypeAdapter(MaakKlantContactResponse)
 MaakKlantContactCreateDataValidator = TypeAdapter(MaakKlantContactCreateData)