Add .test() method to WebhookClient (#60)

Author: fnesveda

CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+[0.3.0](../../releases/tag/v0.3.0) - 2021-08-31
+-----------------------------------------------
+
+### Added
+
+- added the `test()` method to the webhook client
+
 [0.2.0](../../releases/tag/v0.2.0) - 2021-08-09
 -----------------------------------------------
 

docs/docs.md

@@ -2121,6 +2121,7 @@ Sub-client for manipulating a single webhook.
 * [get()](#webhookclient-get)
 * [update()](#webhookclient-update)
 * [delete()](#webhookclient-delete)
+* [test()](#webhookclient-test)
 * [dispatches()](#webhookclient-dispatches)
 
 ***
@@ -2191,6 +2192,24 @@ Delete the webhook.
 
 ***
 
+#### [](#webhookclient-test) `WebhookClient.test()`
+
+Test a webhook.
+
+Creates a webhook dispatch with a dummy payload.
+
+[https://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook](https://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook)
+
+* **Returns**
+
+  The webhook dispatch created by the test
+
+* **Return type**
+
+  `dict`, optional
+
+***
+
 #### [](#webhookclient-dispatches) `WebhookClient.dispatches()`
 
 Get dispatches of the webhook.

src/apify_client/_version.py

@@ -1 +1 @@
-__version__ = '0.2.0'
+__version__ = '0.3.0'

src/apify_client/clients/resource_clients/webhook.py

@@ -1,6 +1,7 @@
 from typing import Any, Dict, List, Optional
 
-from ..._utils import _snake_case_to_camel_case
+from ..._errors import ApifyApiError
+from ..._utils import _catch_not_found_or_throw, _parse_date_fields, _pluck_data, _snake_case_to_camel_case
 from ...consts import WebhookEventType
 from ..base import ResourceClient
 from .webhook_dispatch_collection import WebhookDispatchCollectionClient
@@ -107,6 +108,30 @@ def delete(self) -> None:
         """
         return self._delete()
 
+    def test(self) -> Optional[Dict]:
+        """Test a webhook.
+
+        Creates a webhook dispatch with a dummy payload.
+
+        https://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook
+
+        Returns:
+            dict, optional: The webhook dispatch created by the test
+        """
+        try:
+            response = self.http_client.call(
+                url=self._url('test'),
+                method='POST',
+                params=self._params(),
+            )
+
+            return _parse_date_fields(_pluck_data(response.json()))
+
+        except ApifyApiError as exc:
+            _catch_not_found_or_throw(exc)
+
+        return None
+
     def dispatches(self) -> WebhookDispatchCollectionClient:
         """Get dispatches of the webhook.