nc-py-api 0.14.0__tar.gz → 0.15.1__tar.gz

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/CHANGELOG.md

@@ -2,7 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.14.0 - 2024-07-0X]
+## [0.15.1 - 2024-07-30]
+
+### Fixed
+
+- Corrected behaviour of `ocs` function for `Group Folders` app routes(they are not fully OCS API). #279
+- NextcloudApp: `get_computation_device` function now correctly returns result in upper_case. #278
+
+## [0.15.0 - 2024-07-19]
+
+### Added
+
+- Initial Webhooks API support for the upcoming Nextcloud 30. #272
+
+### Changed
+
+- NextcloudApp: `fetch_models_task` function now saves paths to downloaded models. #274 Thanks to @kyteinsky
+
+## [0.14.0 - 2024-07-09]
 
 ### Added
 

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nc-py-api
-Version: 0.14.0
+Version: 0.15.1
 Summary: Nextcloud Python Framework
 Project-URL: Changelog, https://github.com/cloud-py-api/nc_py_api/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://cloud-py-api.github.io/nc_py_api/
@@ -85,7 +85,7 @@ Description-Content-Type: text/markdown
 [![Docs](https://github.com/cloud-py-api/nc_py_api/actions/workflows/docs.yml/badge.svg)](https://cloud-py-api.github.io/nc_py_api/)
 [![codecov](https://codecov.io/github/cloud-py-api/nc_py_api/branch/main/graph/badge.svg?token=C91PL3FYDQ)](https://codecov.io/github/cloud-py-api/nc_py_api)
 
-![NextcloudVersion](https://img.shields.io/badge/Nextcloud-26%20%7C%2027%20%7C%2028-blue)
+![NextcloudVersion](https://img.shields.io/badge/Nextcloud-27%20%7C%2028%20%7C%2029%20%7C%2030-blue)
 ![PythonVersion](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
 ![impl](https://img.shields.io/pypi/implementation/nc_py_api)
 ![pypi](https://img.shields.io/pypi/v/nc_py_api.svg)
@@ -101,7 +101,7 @@ Python library that provides a robust and well-documented API that allows develo
  * **Sync + Async**: Provides both sync and async APIs.
 
 ### Capabilities
-| **_Capability_**      | Nextcloud 26 | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 |
+| **_Capability_**      | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
 |-----------------------|:------------:|:------------:|:------------:|:------------:|
 | Calendar              |      ✅       |      ✅       |      ✅       |      ✅       |
 | File System & Tags    |      ✅       |      ✅       |      ✅       |      ✅       |
@@ -111,9 +111,9 @@ Python library that provides a robust and well-documented API that allows develo
 | Users & Groups        |      ✅       |      ✅       |      ✅       |      ✅       |
 | User & Weather status |      ✅       |      ✅       |      ✅       |      ✅       |
 | Other APIs***         |      ✅       |      ✅       |      ✅       |      ✅       |
-| Talk Bot API*         |     N/A      |      ✅       |      ✅       |      ✅       |
-| Settings UI API*      |     N/A      |     N/A      |     N/A      |      ✅       |
-| AI Providers API**    |     N/A      |     N/A      |     N/A      |      ✅       |
+| Talk Bot API*         |      ✅       |      ✅       |      ✅       |      ✅       |
+| Settings UI API*      |     N/A      |     N/A      |      ✅       |      ✅       |
+| AI Providers API**    |     N/A      |     N/A      |      ✅       |      ✅       |
 
 &ast;_available only for **NextcloudApp**_<br>
 &ast;&ast;_available only for **NextcloudApp**: SpeechToText, TextProcessing, Translation_<br>

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/README.md

@@ -8,7 +8,7 @@
 [![Docs](https://github.com/cloud-py-api/nc_py_api/actions/workflows/docs.yml/badge.svg)](https://cloud-py-api.github.io/nc_py_api/)
 [![codecov](https://codecov.io/github/cloud-py-api/nc_py_api/branch/main/graph/badge.svg?token=C91PL3FYDQ)](https://codecov.io/github/cloud-py-api/nc_py_api)
 
-![NextcloudVersion](https://img.shields.io/badge/Nextcloud-26%20%7C%2027%20%7C%2028-blue)
+![NextcloudVersion](https://img.shields.io/badge/Nextcloud-27%20%7C%2028%20%7C%2029%20%7C%2030-blue)
 ![PythonVersion](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
 ![impl](https://img.shields.io/pypi/implementation/nc_py_api)
 ![pypi](https://img.shields.io/pypi/v/nc_py_api.svg)
@@ -24,7 +24,7 @@ Python library that provides a robust and well-documented API that allows develo
  * **Sync + Async**: Provides both sync and async APIs.
 
 ### Capabilities
-| **_Capability_**      | Nextcloud 26 | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 |
+| **_Capability_**      | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
 |-----------------------|:------------:|:------------:|:------------:|:------------:|
 | Calendar              |      ✅       |      ✅       |      ✅       |      ✅       |
 | File System & Tags    |      ✅       |      ✅       |      ✅       |      ✅       |
@@ -34,9 +34,9 @@ Python library that provides a robust and well-documented API that allows develo
 | Users & Groups        |      ✅       |      ✅       |      ✅       |      ✅       |
 | User & Weather status |      ✅       |      ✅       |      ✅       |      ✅       |
 | Other APIs***         |      ✅       |      ✅       |      ✅       |      ✅       |
-| Talk Bot API*         |     N/A      |      ✅       |      ✅       |      ✅       |
-| Settings UI API*      |     N/A      |     N/A      |     N/A      |      ✅       |
-| AI Providers API**    |     N/A      |     N/A      |     N/A      |      ✅       |
+| Talk Bot API*         |      ✅       |      ✅       |      ✅       |      ✅       |
+| Settings UI API*      |     N/A      |     N/A      |      ✅       |      ✅       |
+| AI Providers API**    |     N/A      |     N/A      |      ✅       |      ✅       |
 
 &ast;_available only for **NextcloudApp**_<br>
 &ast;&ast;_available only for **NextcloudApp**: SpeechToText, TextProcessing, Translation_<br>

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/nc_py_api/_session.py

@@ -150,7 +150,7 @@ class NcSessionBase(ABC):
         self.init_adapter()
         self.init_adapter_dav()
         self.response_headers = Headers()
-        self._ocs_regexp = re.compile(r"/ocs/v[12]\.php/")
+        self._ocs_regexp = re.compile(r"/ocs/v[12]\.php/|/apps/groupfolders/")
 
     def init_adapter(self, restart=False) -> None:
         if getattr(self, "adapter", None) is None or restart:
@@ -176,12 +176,12 @@ class NcSessionBase(ABC):
 
     @property
     def ae_url(self) -> str:
-        """Return base url for the App Ecosystem endpoints."""
+        """Return base url for the AppAPI endpoints."""
         return "/ocs/v1.php/apps/app_api/api/v1"
 
     @property
     def ae_url_v2(self) -> str:
-        """Return base url for the App Ecosystem endpoints(version 2)."""
+        """Return base url for the AppAPI endpoints(version 2)."""
         return "/ocs/v1.php/apps/app_api/api/v2"
 
 
@@ -289,6 +289,7 @@ class NcSessionBasic(NcSessionBase, ABC):
         str_url = str(request.url)
         if re.search(self._ocs_regexp, str_url) is not None:  # this is OCS call
             request.url = request.url.copy_merge_params({"format": "json"})
+            request.headers["Accept"] = "application/json"
 
     def _response_event(self, response: Response) -> None:
         str_url = str(response.request.url)
@@ -412,6 +413,7 @@ class AsyncNcSessionBasic(NcSessionBase, ABC):
         str_url = str(request.url)
         if re.search(self._ocs_regexp, str_url) is not None:  # this is OCS call
             request.url = request.url.copy_merge_params({"format": "json"})
+            request.headers["Accept"] = "application/json"
 
     async def _response_event(self, response: Response) -> None:
         str_url = str(response.request.url)

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.14.0"
+__version__ = "0.15.1"

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/nc_py_api/apps.py

@@ -43,8 +43,8 @@ class ExAppInfo:
 
     @property
     def system(self) -> bool:
-        """Flag indicating if the application is a system application."""
-        return bool(self._raw_data["system"])
+        """**DEPRECATED** Flag indicating if the application is a system application."""
+        return True
 
     def __repr__(self):
         return f"<{self.__class__.__name__} id={self.app_id}, ver={self.version}>"

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/nc_py_api/ex_app/integration_fastapi.py

@@ -127,22 +127,26 @@ def fetch_models_task(nc: NextcloudApp, models: dict[str, dict], progress_init_s
         percent_for_each = min(int((100 - progress_init_start_value) / len(models)), 99)
         for model in models:
             if model.startswith(("http://", "https://")):
-                __fetch_model_as_file(current_progress, percent_for_each, nc, model, models[model])
+                models[model]["path"] = __fetch_model_as_file(
+                    current_progress, percent_for_each, nc, model, models[model]
+                )
             else:
-                __fetch_model_as_snapshot(current_progress, percent_for_each, nc, model, models[model])
+                models[model]["path"] = __fetch_model_as_snapshot(
+                    current_progress, percent_for_each, nc, model, models[model]
+                )
             current_progress += percent_for_each
     nc.set_init_status(100)
 
 
 def __fetch_model_as_file(
     current_progress: int, progress_for_task: int, nc: NextcloudApp, model_path: str, download_options: dict
-) -> None:
+) -> str | None:
     result_path = download_options.pop("save_path", urlparse(model_path).path.split("/")[-1])
     try:
         with httpx.stream("GET", model_path, follow_redirects=True) as response:
             if not response.is_success:
                 nc.log(LogLvl.ERROR, f"Downloading of '{model_path}' returned {response.status_code} status.")
-                return
+                return None
             downloaded_size = 0
             linked_etag = ""
             for each_history in response.history:
@@ -163,7 +167,7 @@ def __fetch_model_as_file(
                         sha256_hash.update(byte_block)
                     if f'"{sha256_hash.hexdigest()}"' == linked_etag:
                         nc.set_init_status(min(current_progress + progress_for_task, 99))
-                        return
+                        return None
 
             with builtins.open(result_path, "wb") as file:
                 last_progress = current_progress
@@ -174,13 +178,17 @@ def __fetch_model_as_file(
                         if new_progress != last_progress:
                             nc.set_init_status(new_progress)
                             last_progress = new_progress
+
+        return result_path
     except Exception as e:  # noqa pylint: disable=broad-exception-caught
         nc.log(LogLvl.ERROR, f"Downloading of '{model_path}' raised an exception: {e}")
 
+    return None
+
 
 def __fetch_model_as_snapshot(
     current_progress: int, progress_for_task, nc: NextcloudApp, mode_name: str, download_options: dict
-) -> None:
+) -> str:
     from huggingface_hub import snapshot_download  # noqa isort:skip pylint: disable=C0415 disable=E0401
     from tqdm import tqdm  # noqa isort:skip pylint: disable=C0415 disable=E0401
 
@@ -191,7 +199,9 @@ def __fetch_model_as_snapshot(
 
     workers = download_options.pop("max_workers", 2)
     cache = download_options.pop("cache_dir", persistent_storage())
-    snapshot_download(mode_name, tqdm_class=TqdmProgress, **download_options, max_workers=workers, cache_dir=cache)
+    return snapshot_download(
+        mode_name, tqdm_class=TqdmProgress, **download_options, max_workers=workers, cache_dir=cache
+    )
 
 
 def __nc_app(request: HTTPConnection) -> dict:

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/nc_py_api/ex_app/misc.py

@@ -54,4 +54,4 @@ def get_model_path(model_name: str) -> str:
 
 def get_computation_device() -> str:
     """Returns computation device(`ROCM` or `CUDA`) if it is defined in the environment variable."""
-    return os.environ.get("COMPUTE_DEVICE", "")
+    return str(os.environ.get("COMPUTE_DEVICE", "")).upper()

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/nc_py_api/ex_app/providers/task_processing.py

@@ -5,7 +5,7 @@ import dataclasses
 import typing
 
 from ..._exceptions import NextcloudException, NextcloudExceptionNotFound
-from ..._misc import require_capabilities
+from ..._misc import clear_from_params_empty, require_capabilities
 from ..._session import AsyncNcSessionApp, NcSessionApp
 
 _EP_SUFFIX: str = "ai_provider/task_processing"
@@ -43,14 +43,18 @@ class _TaskProcessingProviderAPI:
     def __init__(self, session: NcSessionApp):
         self._session = session
 
-    def register(self, name: str, display_name: str, task_type: str) -> None:
+    def register(
+        self, name: str, display_name: str, task_type: str, custom_task_type: dict[str, typing.Any] | None = None
+    ) -> None:
         """Registers or edit the TaskProcessing provider."""
         require_capabilities("app_api", self._session.capabilities)
         params = {
             "name": name,
             "displayName": display_name,
             "taskType": task_type,
+            "customTaskType": custom_task_type,
         }
+        clear_from_params_empty(["customTaskType"], params)
         self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
 
     def unregister(self, name: str, not_fail=True) -> None:
@@ -118,14 +122,18 @@ class _AsyncTaskProcessingProviderAPI:
     def __init__(self, session: AsyncNcSessionApp):
         self._session = session
 
-    async def register(self, name: str, display_name: str, task_type: str) -> None:
+    async def register(
+        self, name: str, display_name: str, task_type: str, custom_task_type: dict[str, typing.Any] | None = None
+    ) -> None:
         """Registers or edit the TaskProcessing provider."""
         require_capabilities("app_api", await self._session.capabilities)
         params = {
             "name": name,
             "displayName": display_name,
             "taskType": task_type,
+            "customTaskType": custom_task_type,
         }
+        clear_from_params_empty(["customTaskType"], params)
         await self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
 
     async def unregister(self, name: str, not_fail=True) -> None:

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/nc_py_api/files/__init__.py

@@ -203,9 +203,7 @@ class FsNode:
         )
 
     def __eq__(self, other):
-        if self.file_id and self.file_id == other.file_id:
-            return True
-        return False
+        return bool(self.file_id and self.file_id == other.file_id)
 
     @property
     def has_extra(self) -> bool:

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/nc_py_api/nextcloud.py

@@ -44,6 +44,7 @@ from .user_status import _AsyncUserStatusAPI, _UserStatusAPI
 from .users import _AsyncUsersAPI, _UsersAPI
 from .users_groups import _AsyncUsersGroupsAPI, _UsersGroupsAPI
 from .weather_status import _AsyncWeatherStatusAPI, _WeatherStatusAPI
+from .webhooks import _AsyncWebhooksAPI, _WebhooksAPI
 
 
 class _NextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
@@ -71,6 +72,8 @@ class _NextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
     """Nextcloud API for managing users statuses"""
     weather_status: _WeatherStatusAPI
     """Nextcloud API for managing user weather statuses"""
+    webhooks: _WebhooksAPI
+    """Nextcloud API for managing webhooks"""
     _session: NcSessionBasic
 
     def __init__(self, session: NcSessionBasic):
@@ -86,6 +89,7 @@ class _NextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
         self.users_groups = _UsersGroupsAPI(session)
         self.user_status = _UserStatusAPI(session)
         self.weather_status = _WeatherStatusAPI(session)
+        self.webhooks = _WebhooksAPI(session)
 
     @property
     def capabilities(self) -> dict:
@@ -169,6 +173,8 @@ class _AsyncNextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
     """Nextcloud API for managing users statuses"""
     weather_status: _AsyncWeatherStatusAPI
     """Nextcloud API for managing user weather statuses"""
+    webhooks: _AsyncWebhooksAPI
+    """Nextcloud API for managing webhooks"""
     _session: AsyncNcSessionBasic
 
     def __init__(self, session: AsyncNcSessionBasic):
@@ -184,6 +190,7 @@ class _AsyncNextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
         self.users_groups = _AsyncUsersGroupsAPI(session)
         self.user_status = _AsyncUserStatusAPI(session)
         self.weather_status = _AsyncWeatherStatusAPI(session)
+        self.webhooks = _AsyncWebhooksAPI(session)
 
     @property
     async def capabilities(self) -> dict:
@@ -350,14 +357,14 @@ class NextcloudApp(_NextcloudBasic):
         self._session.ocs("POST", f"{self._session.ae_url}/log", json={"level": int(log_lvl), "message": content})
 
     def users_list(self) -> list[str]:
-        """Returns list of users on the Nextcloud instance. **Available** only for ``System`` applications."""
+        """Returns list of users on the Nextcloud instance."""
         return self._session.ocs("GET", f"{self._session.ae_url}/users")
 
     @property
     def user(self) -> str:
         """Property containing the current user ID.
 
-        **System Applications** can change user ID they impersonate with **set_user** method.
+        **ExApps** can change user ID they impersonate with **set_user** method.
         """
         return self._session.user
 
@@ -480,14 +487,14 @@ class AsyncNextcloudApp(_AsyncNextcloudBasic):
         await self._session.ocs("POST", f"{self._session.ae_url}/log", json={"level": int(log_lvl), "message": content})
 
     async def users_list(self) -> list[str]:
-        """Returns list of users on the Nextcloud instance. **Available** only for ``System`` applications."""
+        """Returns list of users on the Nextcloud instance."""
         return await self._session.ocs("GET", f"{self._session.ae_url}/users")
 
     @property
     async def user(self) -> str:
         """Property containing the current user ID.
 
-        **System Applications** can change user ID they impersonate with **set_user** method.
+        **ExApps** can change user ID they impersonate with **set_user** method.
         """
         return await self._session.user
 

nc_py_api-0.15.1/nc_py_api/webhooks.py

@@ -0,0 +1,210 @@
+"""Nextcloud Webhooks API."""
+
+import dataclasses
+
+from ._misc import clear_from_params_empty  # , require_capabilities
+from ._session import AsyncNcSessionBasic, NcSessionBasic
+
+
+@dataclasses.dataclass
+class WebhookInfo:
+    """Information about the Webhook."""
+
+    def __init__(self, raw_data: dict):
+        self._raw_data = raw_data
+
+    @property
+    def webhook_id(self) -> int:
+        """`ID` of the webhook."""
+        return self._raw_data["id"]
+
+    @property
+    def app_id(self) -> str:
+        """`ID` of the ExApp that registered webhook."""
+        return self._raw_data["appId"] if self._raw_data["appId"] else ""
+
+    @property
+    def user_id(self) -> str:
+        """`UserID` if webhook was registered in user context."""
+        return self._raw_data["userId"] if self._raw_data["userId"] else ""
+
+    @property
+    def http_method(self) -> str:
+        """HTTP method used to call webhook."""
+        return self._raw_data["httpMethod"]
+
+    @property
+    def uri(self) -> str:
+        """URL address that will be called for this webhook."""
+        return self._raw_data["uri"]
+
+    @property
+    def event(self) -> str:
+        """Nextcloud PHP event that triggers this webhook."""
+        return self._raw_data["event"]
+
+    @property
+    def event_filter(self):
+        """Mongo filter to apply to the serialized data to decide if firing."""
+        return self._raw_data["eventFilter"]
+
+    @property
+    def user_id_filter(self) -> str:
+        """Currently unknown."""
+        return self._raw_data["userIdFilter"]
+
+    @property
+    def headers(self) -> dict:
+        """Headers that should be added to request when calling webhook."""
+        return self._raw_data["headers"] if self._raw_data["headers"] else {}
+
+    @property
+    def auth_method(self) -> str:
+        """Currently unknown."""
+        return self._raw_data["authMethod"]
+
+    @property
+    def auth_data(self) -> dict:
+        """Currently unknown."""
+        return self._raw_data["authData"] if self._raw_data["authData"] else {}
+
+    def __repr__(self):
+        return f"<{self.__class__.__name__} id={self.webhook_id}, event={self.event}>"
+
+
+class _WebhooksAPI:
+    """The class provides the application management API on the Nextcloud server."""
+
+    _ep_base: str = "/ocs/v1.php/apps/webhook_listeners/api/v1/webhooks"
+
+    def __init__(self, session: NcSessionBasic):
+        self._session = session
+
+    def get_list(self, uri_filter: str = "") -> list[WebhookInfo]:
+        params = {"uri": uri_filter} if uri_filter else {}
+        return [WebhookInfo(i) for i in self._session.ocs("GET", f"{self._ep_base}", params=params)]
+
+    def get_entry(self, webhook_id: int) -> WebhookInfo:
+        return WebhookInfo(self._session.ocs("GET", f"{self._ep_base}/{webhook_id}"))
+
+    def register(
+        self,
+        http_method: str,
+        uri: str,
+        event: str,
+        event_filter: dict | None = None,
+        user_id_filter: str = "",
+        headers: dict | None = None,
+        auth_method: str = "none",
+        auth_data: dict | None = None,
+    ):
+        params = {
+            "httpMethod": http_method,
+            "uri": uri,
+            "event": event,
+            "eventFilter": event_filter,
+            "userIdFilter": user_id_filter,
+            "headers": headers,
+            "authMethod": auth_method,
+            "authData": auth_data,
+        }
+        clear_from_params_empty(["eventFilter", "userIdFilter", "headers", "authMethod", "authData"], params)
+        return WebhookInfo(self._session.ocs("POST", f"{self._ep_base}", json=params))
+
+    def update(
+        self,
+        webhook_id: int,
+        http_method: str,
+        uri: str,
+        event: str,
+        event_filter: dict | None = None,
+        user_id_filter: str = "",
+        headers: dict | None = None,
+        auth_method: str = "none",
+        auth_data: dict | None = None,
+    ):
+        params = {
+            "id": webhook_id,
+            "httpMethod": http_method,
+            "uri": uri,
+            "event": event,
+            "eventFilter": event_filter,
+            "userIdFilter": user_id_filter,
+            "headers": headers,
+            "authMethod": auth_method,
+            "authData": auth_data,
+        }
+        clear_from_params_empty(["eventFilter", "userIdFilter", "headers", "authMethod", "authData"], params)
+        return WebhookInfo(self._session.ocs("POST", f"{self._ep_base}/{webhook_id}", json=params))
+
+    def unregister(self, webhook_id: int) -> bool:
+        return self._session.ocs("DELETE", f"{self._ep_base}/{webhook_id}")
+
+
+class _AsyncWebhooksAPI:
+    """The class provides the async application management API on the Nextcloud server."""
+
+    _ep_base: str = "/ocs/v1.php/webhooks"
+
+    def __init__(self, session: AsyncNcSessionBasic):
+        self._session = session
+
+    async def get_list(self, uri_filter: str = "") -> list[WebhookInfo]:
+        params = {"uri": uri_filter} if uri_filter else {}
+        return [WebhookInfo(i) for i in await self._session.ocs("GET", f"{self._ep_base}", params=params)]
+
+    async def get_entry(self, webhook_id: int) -> WebhookInfo:
+        return WebhookInfo(await self._session.ocs("GET", f"{self._ep_base}/{webhook_id}"))
+
+    async def register(
+        self,
+        http_method: str,
+        uri: str,
+        event: str,
+        event_filter: dict | None = None,
+        user_id_filter: str = "",
+        headers: dict | None = None,
+        auth_method: str = "none",
+        auth_data: dict | None = None,
+    ):
+        params = {
+            "httpMethod": http_method,
+            "uri": uri,
+            "event": event,
+            "eventFilter": event_filter,
+            "userIdFilter": user_id_filter,
+            "headers": headers,
+            "authMethod": auth_method,
+            "authData": auth_data,
+        }
+        clear_from_params_empty(["eventFilter", "userIdFilter", "headers", "authMethod", "authData"], params)
+        return WebhookInfo(await self._session.ocs("POST", f"{self._ep_base}", json=params))
+
+    async def update(
+        self,
+        webhook_id: int,
+        http_method: str,
+        uri: str,
+        event: str,
+        event_filter: dict | None = None,
+        user_id_filter: str = "",
+        headers: dict | None = None,
+        auth_method: str = "none",
+        auth_data: dict | None = None,
+    ):
+        params = {
+            "id": webhook_id,
+            "httpMethod": http_method,
+            "uri": uri,
+            "event": event,
+            "eventFilter": event_filter,
+            "userIdFilter": user_id_filter,
+            "headers": headers,
+            "authMethod": auth_method,
+            "authData": auth_data,
+        }
+        clear_from_params_empty(["eventFilter", "userIdFilter", "headers", "authMethod", "authData"], params)
+        return WebhookInfo(await self._session.ocs("POST", f"{self._ep_base}/{webhook_id}", json=params))
+
+    async def unregister(self, webhook_id: int) -> bool:
+        return await self._session.ocs("DELETE", f"{self._ep_base}/{webhook_id}")

{nc_py_api-0.14.0 → nc_py_api-0.15.1}/pyproject.toml

@@ -177,7 +177,7 @@ design.max-attributes = 8
 design.max-locals = 20
 design.max-branches = 16
 design.max-returns = 8
-design.max-args = 8
+design.max-args = 10
 basic.good-names = [
   "a",
   "b",