MPT-14075 Add notifications contacts (#71)

Author: d3rky

mpt_api_client/resources/accounts/accounts.py

@@ -1,5 +1,6 @@
 from mpt_api_client.http import AsyncHTTPClient, HTTPClient
 from mpt_api_client.resources.accounts.account import AccountsService, AsyncAccountsService
+from mpt_api_client.resources.accounts.users import AsyncUsersService, UsersService
 
 
 class Accounts:
@@ -13,6 +14,11 @@ def accounts(self) -> AccountsService:
         """Accounts service."""
         return AccountsService(http_client=self.http_client)
 
+    @property
+    def users(self) -> UsersService:
+        """Users service."""
+        return UsersService(http_client=self.http_client)
+
 
 class AsyncAccounts:
     """Async Accounts MPT API Module."""
@@ -24,3 +30,8 @@ def __init__(self, *, http_client: AsyncHTTPClient):
     def accounts(self) -> AsyncAccountsService:
         """Accounts service."""
         return AsyncAccountsService(http_client=self.http_client)
+
+    @property
+    def users(self) -> AsyncUsersService:
+        """Users service."""
+        return AsyncUsersService(http_client=self.http_client)

mpt_api_client/resources/accounts/mixins.py

@@ -71,6 +71,32 @@ def validate(self, resource_id: str, resource_data: ResourceData | None = None)
         )
 
 
+class BlockableMixin[Model]:
+    """Blockable mixin for blocking and unblocking resources."""
+
+    def block(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Block a resource.
+
+        Args:
+            resource_id: Resource ID
+            resource_data: Resource data will be updated
+        """
+        return self._resource_action(  # type: ignore[attr-defined, no-any-return]
+            resource_id, "POST", "block", json=resource_data
+        )
+
+    def unblock(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Unblock a resource.
+
+        Args:
+            resource_id: Resource ID
+            resource_data: Resource data will be updated
+        """
+        return self._resource_action(  # type: ignore[attr-defined, no-any-return]
+            resource_id, "POST", "unblock", json=resource_data
+        )
+
+
 class AsyncActivatableMixin[Model]:
     """Async activatable mixin for activating, enabling, disabling and deactivating resources."""
 
@@ -138,3 +164,29 @@ async def validate(self, resource_id: str, resource_data: ResourceData | None =
         return await self._resource_action(  # type: ignore[attr-defined, no-any-return]
             resource_id, "POST", "validate", json=resource_data
         )
+
+
+class AsyncBlockableMixin[Model]:
+    """Asynchronous Blockable mixin for blocking and unblocking resources."""
+
+    async def block(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Block a resource.
+
+        Args:
+            resource_id: Resource ID
+            resource_data: Resource data will be updated
+        """
+        return await self._resource_action(  # type: ignore[attr-defined, no-any-return]
+            resource_id, "POST", "block", json=resource_data
+        )
+
+    async def unblock(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Unblock a resource.
+
+        Args:
+            resource_id: Resource ID
+            resource_data: Resource data will be updated
+        """
+        return await self._resource_action(  # type: ignore[attr-defined, no-any-return]
+            resource_id, "POST", "unblock", json=resource_data
+        )

mpt_api_client/resources/accounts/users.py

@@ -0,0 +1,85 @@
+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.models.model import ResourceData
+from mpt_api_client.resources.accounts.mixins import (
+    AsyncBlockableMixin,
+    BlockableMixin,
+)
+
+
+class User(Model):
+    """User resource."""
+
+
+class UsersServiceConfig:
+    """Users service configuration."""
+
+    _endpoint = "/public/v1/accounts/users"
+    _model_class = User
+    _collection_key = "data"
+
+
+class UsersService(
+    CreateMixin[User],
+    UpdateMixin[User],
+    DeleteMixin,
+    BlockableMixin[User],
+    Service[User],
+    UsersServiceConfig,
+):
+    """Users service."""
+
+    def sso(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """SSO a resource.
+
+        Args:
+            resource_id: Resource ID
+            resource_data: Resource data will be updated
+        """
+        return self._resource_action(resource_id, "POST", "sso", json=resource_data)
+
+    def sso_check(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Check SSO for a resource.
+
+        Args:
+            resource_id: Resource ID
+            resource_data: Resource data will be updated
+        """
+        return self._resource_action(resource_id, "POST", "sso-check", json=resource_data)
+
+
+class AsyncUsersService(
+    AsyncCreateMixin[User],
+    AsyncUpdateMixin[User],
+    AsyncDeleteMixin,
+    AsyncBlockableMixin[User],
+    AsyncService[User],
+    UsersServiceConfig,
+):
+    """Async Users service."""
+
+    async def sso(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """SSO a resource.
+
+        Args:
+            resource_id: Resource ID
+            resource_data: Resource data will be updated
+        """
+        return await self._resource_action(resource_id, "POST", "sso", json=resource_data)
+
+    async def sso_check(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Check SSO for a resource.
+
+        Args:
+            resource_id: Resource ID
+            resource_data: Resource data will be updated
+        """
+        return await self._resource_action(resource_id, "POST", "sso-check", json=resource_data)

mpt_api_client/resources/notifications/contacts.py

@@ -0,0 +1,57 @@
+from mpt_api_client.http import AsyncService, CreateMixin, Service
+from mpt_api_client.http.mixins import (
+    AsyncCreateMixin,
+    AsyncDeleteMixin,
+    AsyncUpdateMixin,
+    DeleteMixin,
+    UpdateMixin,
+)
+from mpt_api_client.models import Model, ResourceData
+
+
+class Contact(Model):
+    """Notifications Contact resource."""
+
+
+class ContactsServiceConfig:
+    """Notifications Contacts service configuration."""
+
+    _endpoint = "/public/v1/notifications/contacts"
+    _model_class = Contact
+    _collection_key = "data"
+
+
+class ContactsService(
+    CreateMixin[Contact],
+    UpdateMixin[Contact],
+    DeleteMixin,
+    Service[Contact],
+    ContactsServiceConfig,
+):
+    """Notifications Contacts service."""
+
+    def block(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Block a contact."""
+        return self._resource_action(resource_id, "POST", "block", json=resource_data)
+
+    def unblock(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Unblock a contact."""
+        return self._resource_action(resource_id, "POST", "unblock", json=resource_data)
+
+
+class AsyncContactsService(
+    AsyncCreateMixin[Contact],
+    AsyncUpdateMixin[Contact],
+    AsyncDeleteMixin,
+    AsyncService[Contact],
+    ContactsServiceConfig,
+):
+    """Async Notifications Contacts service."""
+
+    async def block(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Block a contact."""
+        return await self._resource_action(resource_id, "POST", "block", json=resource_data)
+
+    async def unblock(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Unblock a contact."""
+        return await self._resource_action(resource_id, "POST", "unblock", json=resource_data)

mpt_api_client/resources/notifications/notifications.py

@@ -3,6 +3,7 @@
     AsyncCategoriesService,
     CategoriesService,
 )
+from mpt_api_client.resources.notifications.contacts import AsyncContactsService, ContactsService
 
 
 class Notifications:
@@ -16,6 +17,11 @@ def categories(self) -> CategoriesService:
         """Categories service."""
         return CategoriesService(http_client=self.http_client)
 
+    @property
+    def contacts(self) -> ContactsService:
+        """Contacts service."""
+        return ContactsService(http_client=self.http_client)
+
 
 class AsyncNotifications:
     """Notifications MPT API Module."""
@@ -27,3 +33,8 @@ def __init__(self, http_client: AsyncHTTPClient):
     def categories(self) -> AsyncCategoriesService:
         """Categories service."""
         return AsyncCategoriesService(http_client=self.http_client)
+
+    @property
+    def contacts(self) -> AsyncContactsService:
+        """Async Contacts service."""
+        return AsyncContactsService(http_client=self.http_client)

setup.cfg

@@ -32,22 +32,19 @@ extend-ignore =
 
 
 per-file-ignores =
-  mpt_api_client/resources/accounts/*.py: WPS215
+  mpt_api_client/resources/accounts/*.py: WPS215 WPS202
   mpt_api_client/mpt_client.py: WPS214 WPS235
-  mpt_api_client/resources/audit/*.py: WPS215
-  mpt_api_client/resources/billing/*.py: WPS215 WPS202 WPS214 WPS204
-  mpt_api_client/resources/catalog/*.py: WPS110 WPS215 WPS214
-  mpt_api_client/resources/commerce/*.py: WPS215
-  mpt_api_client/rql/query_builder.py: WPS110 WPS115 WPS210 WPS214
-  mpt_api_client/resources/catalog/products.py: WPS204 WPS214 WPS215
-  mpt_api_client/resources/notifications/categories.py: WPS215
   mpt_api_client/http/mixins.py: WPS202
-  mpt_api_client/mpt_client.py: WPS235
+  mpt_api_client/resources/*: WPS215
+  mpt_api_client/resources/billing/*.py: WPS202 WPS204 WPS214 WPS215
+  mpt_api_client/resources/catalog/*.py: WPS110 WPS214 WPS215
+  mpt_api_client/resources/catalog/products.py: WPS204 WPS214 WPS215
+  mpt_api_client/rql/query_builder.py: WPS110 WPS115 WPS210 WPS214
   tests/http/test_async_service.py: WPS204 WPS202
   tests/http/test_service.py: WPS204 WPS202
   tests/http/test_mixins.py: WPS204 WPS202
   tests/resources/catalog/test_products.py: WPS202 WPS210
-  tests/resources/*/test_mixins.py: WPS118 WPS202 WPS204
+  tests/resources/*/test_mixins.py: WPS118 WPS202 WPS204 WPS235
   tests/test_mpt_client.py: WPS235
 
   tests/*:

tests/resources/accounts/test_accounts.py

@@ -2,6 +2,7 @@
 
 from mpt_api_client.resources.accounts.account import AccountsService, AsyncAccountsService
 from mpt_api_client.resources.accounts.accounts import Accounts, AsyncAccounts
+from mpt_api_client.resources.accounts.users import AsyncUsersService, UsersService
 
 
 @pytest.fixture
@@ -15,7 +16,11 @@ def async_accounts(async_http_client):
 
 
 @pytest.mark.parametrize(
-    ("property_name", "expected_service_class"), [("accounts", AccountsService)]
+    ("property_name", "expected_service_class"),
+    [
+        ("accounts", AccountsService),
+        ("users", UsersService),
+    ],
 )
 def test_accounts_properties(accounts, property_name, expected_service_class):
     """Test that Accounts properties return correct instances."""
@@ -26,7 +31,11 @@ def test_accounts_properties(accounts, property_name, expected_service_class):
 
 
 @pytest.mark.parametrize(
-    ("property_name", "expected_service_class"), [("accounts", AsyncAccountsService)]
+    ("property_name", "expected_service_class"),
+    [
+        ("accounts", AsyncAccountsService),
+        ("users", AsyncUsersService),
+    ],
 )
 def test_async_accounts_properties(async_accounts, property_name, expected_service_class):
     """Test that AsyncAccounts properties return correct instances."""