scrapely-client-python 3.1.3__py3-none-any.whl

scrapely_client/_resource_clients/webhook_dispatch_collection.py

@@ -0,0 +1,158 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from scrapely_client._docs import docs_group
+from scrapely_client._models import ListOfWebhookDispatches, ListOfWebhookDispatchesResponse
+from scrapely_client._pagination import get_items_iterator, get_items_iterator_async
+from scrapely_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterator, Iterator
+
+    from scrapely_client._models import WebhookDispatch
+    from scrapely_client.types import Timeout
+
+
+@docs_group('Resource clients')
+class WebhookDispatchCollectionClient(ResourceClient):
+    """Sub-client for the webhook dispatch collection.
+
+    Provides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the
+    `ApifyClient` class.
+    """
+
+    def __init__(
+        self,
+        *,
+        resource_path: str = 'webhook-dispatches',
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(
+            resource_path=resource_path,
+            **kwargs,
+        )
+
+    def list(
+        self,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+        desc: bool | None = None,
+        timeout: Timeout = 'medium',
+    ) -> ListOfWebhookDispatches:
+        """List all webhook dispatches of a user.
+
+
+        Args:
+            limit: How many webhook dispatches to retrieve.
+            offset: What webhook dispatch to include as first when retrieving the list.
+            desc: Whether to sort the webhook dispatches in descending order based on the date of their creation.
+            timeout: Timeout for the API HTTP request.
+
+        Returns:
+            The retrieved webhook dispatches of a user.
+        """
+        result = self._list(timeout=timeout, limit=limit, offset=offset, desc=desc)
+        return ListOfWebhookDispatchesResponse.model_validate(result).data
+
+    def iterate(
+        self,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+        desc: bool | None = None,
+        timeout: Timeout = 'medium',
+    ) -> Iterator[WebhookDispatch]:
+        """Iterate over all webhook dispatches of a user.
+
+        Simple `list` does only one API call, possibly not listing all items matching the criteria. This method
+        returns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.
+
+
+        Args:
+            limit: How many webhook dispatches to retrieve.
+            offset: What webhook dispatch to include as first when retrieving the list.
+            desc: Whether to sort the webhook dispatches in descending order based on the date of their creation.
+            timeout: Timeout for the API HTTP request.
+
+        Yields:
+            The webhook dispatches of a user matching the specified filters.
+        """
+
+        def _callback(*, limit: int | None = None, offset: int | None = None) -> ListOfWebhookDispatches:
+            return self.list(limit=limit, offset=offset, desc=desc, timeout=timeout)
+
+        return get_items_iterator(_callback, limit=limit, offset=offset)
+
+
+@docs_group('Resource clients')
+class WebhookDispatchCollectionClientAsync(ResourceClientAsync):
+    """Sub-client for the webhook dispatch collection.
+
+    Provides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the
+    `ApifyClientAsync` class.
+    """
+
+    def __init__(
+        self,
+        *,
+        resource_path: str = 'webhook-dispatches',
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(
+            resource_path=resource_path,
+            **kwargs,
+        )
+
+    async def list(
+        self,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+        desc: bool | None = None,
+        timeout: Timeout = 'medium',
+    ) -> ListOfWebhookDispatches:
+        """List all webhook dispatches of a user.
+
+
+        Args:
+            limit: How many webhook dispatches to retrieve.
+            offset: What webhook dispatch to include as first when retrieving the list.
+            desc: Whether to sort the webhook dispatches in descending order based on the date of their creation.
+            timeout: Timeout for the API HTTP request.
+
+        Returns:
+            The retrieved webhook dispatches of a user.
+        """
+        result = await self._list(timeout=timeout, limit=limit, offset=offset, desc=desc)
+        return ListOfWebhookDispatchesResponse.model_validate(result).data
+
+    def iterate(
+        self,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+        desc: bool | None = None,
+        timeout: Timeout = 'medium',
+    ) -> AsyncIterator[WebhookDispatch]:
+        """Iterate over all webhook dispatches of a user.
+
+        Simple `list` does only one API call, possibly not listing all items matching the criteria. This method
+        returns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.
+
+
+        Args:
+            limit: How many webhook dispatches to retrieve.
+            offset: What webhook dispatch to include as first when retrieving the list.
+            desc: Whether to sort the webhook dispatches in descending order based on the date of their creation.
+            timeout: Timeout for the API HTTP request.
+
+        Yields:
+            The webhook dispatches of a user matching the specified filters.
+        """
+
+        async def _callback(*, limit: int | None = None, offset: int | None = None) -> ListOfWebhookDispatches:
+            return await self.list(limit=limit, offset=offset, desc=desc, timeout=timeout)
+
+        return get_items_iterator_async(_callback, limit=limit, offset=offset)