MPT-12840 Add agreements assets

Author: albertsola

mpt_api_client/http/async_service.py

@@ -91,19 +91,6 @@ async def get(self, resource_id: str, select: list[str] | str | None = None) ->
             select = ",".join(select) if select else None
         return await self._resource_action(resource_id=resource_id, query_params={"select": select})
 
-    async def update(self, resource_id: str, resource_data: ResourceData) -> Model:
-        """Update a resource using `PUT /endpoint/{resource_id}`.
-
-        Args:
-            resource_id: Resource ID.
-            resource_data: Resource data.
-
-        Returns:
-            Resource object.
-
-        """
-        return await self._resource_action(resource_id, "PUT", json=resource_data)
-
     async def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> httpx.Response:
         """Fetch one page of resources.
 
@@ -119,7 +106,7 @@ async def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> ht
 
         return response
 
-    async def _resource_do_request(
+    async def _resource_do_request(  # noqa: WPS211
         self,
         resource_id: str,
         method: str = "GET",
@@ -144,7 +131,7 @@ async def _resource_do_request(
         Raises:
             HTTPError: If the action fails.
         """
-        resource_url = urljoin(f"{self._endpoint}/", resource_id)
+        resource_url = urljoin(f"{self.endpoint}/", resource_id)
         url = urljoin(f"{resource_url}/", action) if action else resource_url
         response = await self.http_client.request(
             method, url, json=json, params=query_params, headers=headers

mpt_api_client/http/mixins.py

@@ -31,6 +31,23 @@ def delete(self, resource_id: str) -> None:
         response.raise_for_status()
 
 
+class UpdateMixin[Model]:
+    """Update resource mixin."""
+
+    def update(self, resource_id: str, resource_data: ResourceData) -> Model:
+        """Update a resource using `PUT /endpoint/{resource_id}`.
+
+        Args:
+            resource_id: Resource ID.
+            resource_data: Resource data.
+
+        Returns:
+            Resource object.
+
+        """
+        return self._resource_action(resource_id, "PUT", json=resource_data)  # type: ignore[attr-defined, no-any-return]
+
+
 class AsyncCreateMixin[Model]:
     """Create resource mixin."""
 
@@ -58,3 +75,20 @@ async def delete(self, resource_id: str) -> None:
         url = urljoin(f"{self.endpoint}/", resource_id)  # type: ignore[attr-defined]
         response = await self.http_client.delete(url)  # type: ignore[attr-defined]
         response.raise_for_status()
+
+
+class AsyncUpdateMixin[Model]:
+    """Update resource mixin."""
+
+    async def update(self, resource_id: str, resource_data: ResourceData) -> Model:
+        """Update a resource using `PUT /endpoint/{resource_id}`.
+
+        Args:
+            resource_id: Resource ID.
+            resource_data: Resource data.
+
+        Returns:
+            Resource object.
+
+        """
+        return await self._resource_action(resource_id, "PUT", json=resource_data)  # type: ignore[attr-defined, no-any-return]

mpt_api_client/http/service.py

@@ -91,19 +91,6 @@ def get(self, resource_id: str, select: list[str] | str | None = None) -> Model:
 
         return self._resource_action(resource_id=resource_id, query_params={"select": select})
 
-    def update(self, resource_id: str, resource_data: ResourceData) -> Model:
-        """Update a resource using `PUT /endpoint/{resource_id}`.
-
-        Args:
-            resource_id: Resource ID.
-            resource_data: Resource data.
-
-        Returns:
-            Resource object.
-
-        """
-        return self._resource_action(resource_id, "PUT", json=resource_data)
-
     def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> httpx.Response:
         """Fetch one page of resources.
 
@@ -119,7 +106,7 @@ def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> httpx.Re
 
         return response
 
-    def _resource_do_request(
+    def _resource_do_request(  # noqa: WPS211
         self,
         resource_id: str,
         method: str = "GET",

mpt_api_client/models/__init__.py

@@ -1,6 +1,6 @@
 from mpt_api_client.models.collection import Collection
+from mpt_api_client.models.download_file import DownloadFile
 from mpt_api_client.models.meta import Meta, Pagination
 from mpt_api_client.models.model import Model, ResourceData
-from mpt_api_client.models.file import File
 
-__all__ = ["Collection", "Meta", "Model", "Pagination", "ResourceData"]  # noqa: WPS410
+__all__ = ["Collection", "DownloadFile", "Meta", "Model", "Pagination", "ResourceData"]  # noqa: WPS410

mpt_api_client/models/file.py renamed to mpt_api_client/models/download_file.py

@@ -3,7 +3,7 @@
 from httpx import Response
 
 
-class File:
+class DownloadFile:
     """File resource."""
 
     def __init__(self, response: Response):
@@ -32,7 +32,7 @@ def filename(self) -> str | None:
         return None
 
     @property
-    def content(self) -> bytes:
+    def file_contents(self) -> bytes:
         """Returns the content of the attachment.
 
         Returns:
@@ -51,5 +51,5 @@ def content_type(self) -> str | None:
         Returns:
             The content type of the attachment.
         """
-        ctype = self.response.headers.get("content-type")
-        return str(ctype) if ctype else None
+        ctype = self.response.headers.get("content-type", "")
+        return str(ctype)

mpt_api_client/resources/commerce/agreements.py

@@ -1,6 +1,14 @@
 from mpt_api_client.http import AsyncService, Service
+from mpt_api_client.http.mixins import (
+    AsyncCreateMixin,
+    AsyncDeleteMixin,
+    AsyncUpdateMixin,
+    CreateMixin,
+    DeleteMixin,
+    UpdateMixin,
+)
 from mpt_api_client.models import Model
-from mpt_api_client.resources.commerce.agreements_assets import (
+from mpt_api_client.resources.commerce.agreements_attachments import (
     AgreementsAttachmentService,
     AsyncAgreementsAttachmentService,
 )
@@ -18,7 +26,13 @@ class AgreementsServiceConfig:
     _collection_key = "data"
 
 
-class AgreementsService(Service[Agreement], AgreementsServiceConfig):
+class AgreementsService(  # noqa: WPS215
+    CreateMixin[Agreement],
+    UpdateMixin[Agreement],
+    DeleteMixin,
+    Service[Agreement],
+    AgreementsServiceConfig,
+):
     """Agreements service."""
 
     def template(self, agreement_id: str) -> str:
@@ -48,7 +62,13 @@ def attachments(self, agreement_id: str) -> AgreementsAttachmentService:
         )
 
 
-class AsyncAgreementsService(AsyncService[Agreement], AgreementsServiceConfig):
+class AsyncAgreementsService(  # noqa: WPS215
+    AsyncCreateMixin[Agreement],
+    AsyncUpdateMixin[Agreement],
+    AsyncDeleteMixin,
+    AsyncService[Agreement],
+    AgreementsServiceConfig,
+):
     """Agreements service."""
 
     async def template(self, agreement_id: str) -> str: