pipedream 2.1.5__tar.gz → 2.1.7__tar.gz

{pipedream-2.1.5 → pipedream-2.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pipedream
-Version: 2.1.5
+Version: 2.1.7
 Summary: 
 Requires-Python: >=3.10,<4.0
 Classifier: Intended Audience :: Developers

{pipedream-2.1.5 → pipedream-2.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 
 [tool.poetry]
 name = "pipedream"
-version = "2.1.5"
+version = "2.1.7"
 description = ""
 readme = "README.md"
 authors = []

{pipedream-2.1.5 → pipedream-2.1.7}/src/pipedream/apps/__init__.py

@@ -7,7 +7,12 @@ from importlib import import_module
 
 if typing.TYPE_CHECKING:
     from .types import AppsListRequestSortDirection, AppsListRequestSortKey
-_dynamic_imports: typing.Dict[str, str] = {"AppsListRequestSortDirection": ".types", "AppsListRequestSortKey": ".types"}
+    from . import v_2
+_dynamic_imports: typing.Dict[str, str] = {
+    "AppsListRequestSortDirection": ".types",
+    "AppsListRequestSortKey": ".types",
+    "v_2": ".v_2",
+}
 
 
 def __getattr__(attr_name: str) -> typing.Any:
@@ -31,4 +36,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["AppsListRequestSortDirection", "AppsListRequestSortKey"]
+__all__ = ["AppsListRequestSortDirection", "AppsListRequestSortKey", "v_2"]

pipedream-2.1.7/src/pipedream/apps/client.py

@@ -0,0 +1,351 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
+from ..core.request_options import RequestOptions
+from ..types.app import App
+from ..types.get_app_response import GetAppResponse
+from ..types.list_apps_response import ListAppsResponse
+from .raw_client import AsyncRawAppsClient, RawAppsClient
+from .types.apps_list_request_sort_direction import AppsListRequestSortDirection
+from .types.apps_list_request_sort_key import AppsListRequestSortKey
+
+if typing.TYPE_CHECKING:
+    from .v_2.client import AsyncV2Client, V2Client
+
+
+class AppsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAppsClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._v_2: typing.Optional[V2Client] = None
+
+    @property
+    def with_raw_response(self) -> RawAppsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAppsClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        after: typing.Optional[str] = None,
+        before: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        q: typing.Optional[str] = None,
+        sort_key: typing.Optional[AppsListRequestSortKey] = None,
+        sort_direction: typing.Optional[AppsListRequestSortDirection] = None,
+        category_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        has_components: typing.Optional[bool] = None,
+        has_actions: typing.Optional[bool] = None,
+        has_triggers: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SyncPager[App, ListAppsResponse]:
+        """
+        Retrieve all available apps with optional filtering and sorting
+
+        Parameters
+        ----------
+        after : typing.Optional[str]
+            The cursor to start from for pagination
+
+        before : typing.Optional[str]
+            The cursor to end before for pagination
+
+        limit : typing.Optional[int]
+            The maximum number of results to return
+
+        q : typing.Optional[str]
+            A search query to filter the apps
+
+        sort_key : typing.Optional[AppsListRequestSortKey]
+            The key to sort the apps by
+
+        sort_direction : typing.Optional[AppsListRequestSortDirection]
+            The direction to sort the apps
+
+        category_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Only return apps in these categories
+
+        has_components : typing.Optional[bool]
+            Only return apps that have components (actions or triggers)
+
+        has_actions : typing.Optional[bool]
+            Only return apps that have actions
+
+        has_triggers : typing.Optional[bool]
+            Only return apps that have triggers
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SyncPager[App, ListAppsResponse]
+            apps listed
+
+        Examples
+        --------
+        from pipedream import Pipedream
+
+        client = Pipedream(
+            project_id="YOUR_PROJECT_ID",
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        response = client.apps.list(
+            after="after",
+            before="before",
+            limit=1,
+            q="q",
+            sort_key="name",
+            sort_direction="asc",
+            category_ids=["category_ids"],
+            has_components=True,
+            has_actions=True,
+            has_triggers=True,
+        )
+        for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        for page in response.iter_pages():
+            yield page
+        """
+        return self._raw_client.list(
+            after=after,
+            before=before,
+            limit=limit,
+            q=q,
+            sort_key=sort_key,
+            sort_direction=sort_direction,
+            category_ids=category_ids,
+            has_components=has_components,
+            has_actions=has_actions,
+            has_triggers=has_triggers,
+            request_options=request_options,
+        )
+
+    def retrieve(self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetAppResponse:
+        """
+        Get detailed information about a specific app by ID or name slug
+
+        Parameters
+        ----------
+        app_id : str
+            The name slug or ID of the app (e.g., 'slack', 'github')
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetAppResponse
+            app retrieved
+
+        Examples
+        --------
+        from pipedream import Pipedream
+
+        client = Pipedream(
+            project_id="YOUR_PROJECT_ID",
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.apps.retrieve(
+            app_id="app_id",
+        )
+        """
+        _response = self._raw_client.retrieve(app_id, request_options=request_options)
+        return _response.data
+
+    @property
+    def v_2(self):
+        if self._v_2 is None:
+            from .v_2.client import V2Client  # noqa: E402
+
+            self._v_2 = V2Client(client_wrapper=self._client_wrapper)
+        return self._v_2
+
+
+class AsyncAppsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAppsClient(client_wrapper=client_wrapper)
+        self._client_wrapper = client_wrapper
+        self._v_2: typing.Optional[AsyncV2Client] = None
+
+    @property
+    def with_raw_response(self) -> AsyncRawAppsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAppsClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        after: typing.Optional[str] = None,
+        before: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        q: typing.Optional[str] = None,
+        sort_key: typing.Optional[AppsListRequestSortKey] = None,
+        sort_direction: typing.Optional[AppsListRequestSortDirection] = None,
+        category_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        has_components: typing.Optional[bool] = None,
+        has_actions: typing.Optional[bool] = None,
+        has_triggers: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncPager[App, ListAppsResponse]:
+        """
+        Retrieve all available apps with optional filtering and sorting
+
+        Parameters
+        ----------
+        after : typing.Optional[str]
+            The cursor to start from for pagination
+
+        before : typing.Optional[str]
+            The cursor to end before for pagination
+
+        limit : typing.Optional[int]
+            The maximum number of results to return
+
+        q : typing.Optional[str]
+            A search query to filter the apps
+
+        sort_key : typing.Optional[AppsListRequestSortKey]
+            The key to sort the apps by
+
+        sort_direction : typing.Optional[AppsListRequestSortDirection]
+            The direction to sort the apps
+
+        category_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Only return apps in these categories
+
+        has_components : typing.Optional[bool]
+            Only return apps that have components (actions or triggers)
+
+        has_actions : typing.Optional[bool]
+            Only return apps that have actions
+
+        has_triggers : typing.Optional[bool]
+            Only return apps that have triggers
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncPager[App, ListAppsResponse]
+            apps listed
+
+        Examples
+        --------
+        import asyncio
+
+        from pipedream import AsyncPipedream
+
+        client = AsyncPipedream(
+            project_id="YOUR_PROJECT_ID",
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+
+
+        async def main() -> None:
+            response = await client.apps.list(
+                after="after",
+                before="before",
+                limit=1,
+                q="q",
+                sort_key="name",
+                sort_direction="asc",
+                category_ids=["category_ids"],
+                has_components=True,
+                has_actions=True,
+                has_triggers=True,
+            )
+            async for item in response:
+                yield item
+
+            # alternatively, you can paginate page-by-page
+            async for page in response.iter_pages():
+                yield page
+
+
+        asyncio.run(main())
+        """
+        return await self._raw_client.list(
+            after=after,
+            before=before,
+            limit=limit,
+            q=q,
+            sort_key=sort_key,
+            sort_direction=sort_direction,
+            category_ids=category_ids,
+            has_components=has_components,
+            has_actions=has_actions,
+            has_triggers=has_triggers,
+            request_options=request_options,
+        )
+
+    async def retrieve(self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetAppResponse:
+        """
+        Get detailed information about a specific app by ID or name slug
+
+        Parameters
+        ----------
+        app_id : str
+            The name slug or ID of the app (e.g., 'slack', 'github')
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetAppResponse
+            app retrieved
+
+        Examples
+        --------
+        import asyncio
+
+        from pipedream import AsyncPipedream
+
+        client = AsyncPipedream(
+            project_id="YOUR_PROJECT_ID",
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+
+
+        async def main() -> None:
+            await client.apps.retrieve(
+                app_id="app_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.retrieve(app_id, request_options=request_options)
+        return _response.data
+
+    @property
+    def v_2(self):
+        if self._v_2 is None:
+            from .v_2.client import AsyncV2Client  # noqa: E402
+
+            self._v_2 = AsyncV2Client(client_wrapper=self._client_wrapper)
+        return self._v_2