pipedream 2.1.3__tar.gz → 2.1.5__tar.gz

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

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

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

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

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

@@ -0,0 +1,683 @@
+# This file was auto-generated by Fern from our API Definition.
+
+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 ..types.list_response import ListResponse
+from .raw_client import AsyncRawAppsClient, RawAppsClient
+from .types.apps_list_request_sort_direction import AppsListRequestSortDirection
+from .types.apps_list_request_sort_key import AppsListRequestSortKey
+
+
+class AppsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAppsClient(client_wrapper=client_wrapper)
+
+    @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
+
+    def index(
+        self,
+        project_id: str,
+        *,
+        q: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        page: typing.Optional[int] = None,
+        category_name: typing.Optional[str] = None,
+        auth_type: typing.Optional[str] = None,
+        has_components: typing.Optional[str] = None,
+        has_actions: typing.Optional[str] = None,
+        has_triggers: typing.Optional[str] = None,
+        has_private_components: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListResponse:
+        """
+        Parameters
+        ----------
+        project_id : str
+            Project ID (proj_...)
+
+        q : typing.Optional[str]
+
+        limit : typing.Optional[int]
+
+        page : typing.Optional[int]
+
+        category_name : typing.Optional[str]
+
+        auth_type : typing.Optional[str]
+
+        has_components : typing.Optional[str]
+            Component filters, mirroring Rails `V1::AppsController#having_components`:
+            the param's presence selects the filter and its boolean value picks the
+            direction (`false`/`0`/`f`/`off`/empty → apps *without*, anything else →
+            apps *with*). `has_components` means "has actions or triggers". Only the
+            first present of `has_components` > `has_actions` > `has_triggers` applies.
+
+        has_actions : typing.Optional[str]
+
+        has_triggers : typing.Optional[str]
+
+        has_private_components : typing.Optional[str]
+            Not supported yet in the Rust port — Rails uses
+            `PublishedComponentTypesenseSearch.app_slugs_for_owner_keys` here, and
+            we haven't ported that. Returns 501 when set.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListResponse
+            Paginated list of apps
+
+        Examples
+        --------
+        from pipedream import Pipedream
+
+        client = Pipedream(
+            project_id="YOUR_PROJECT_ID",
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.apps.index(
+            project_id="project_id",
+            q="q",
+            limit=1000000,
+            page=1000000,
+            category_name="category_name",
+            auth_type="auth_type",
+            has_components="has_components",
+            has_actions="has_actions",
+            has_triggers="has_triggers",
+            has_private_components="has_private_components",
+        )
+        """
+        _response = self._raw_client.index(
+            project_id,
+            q=q,
+            limit=limit,
+            page=page,
+            category_name=category_name,
+            auth_type=auth_type,
+            has_components=has_components,
+            has_actions=has_actions,
+            has_triggers=has_triggers,
+            has_private_components=has_private_components,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def facets(self, project_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+        """
+        Mirrors `V1::AppsController#v2_facets` (`AppTypesenseSearch.facets`):
+        returns `{ data: { category_name: [...], auth_type: [...] } }`.
+
+        Parameters
+        ----------
+        project_id : str
+            Project ID (proj_...)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Any
+            Facet values keyed by field under `data`
+
+        Examples
+        --------
+        from pipedream import Pipedream
+
+        client = Pipedream(
+            project_id="YOUR_PROJECT_ID",
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.apps.facets(
+            project_id="project_id",
+        )
+        """
+        _response = self._raw_client.facets(project_id, request_options=request_options)
+        return _response.data
+
+    def show(self, project_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+        """
+        Looks up a single app by hashid (e.g. `app_abc123`) or name_slug (e.g. `github`).
+        If the value starts with `app_` it is treated as a hashid and matched against
+        the document `id` field; otherwise it is matched against `name_slug`.
+
+        Parameters
+        ----------
+        project_id : str
+            Project ID (proj_...)
+
+        id : str
+            App hashid (app_...) or name slug (e.g. github)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Any
+            The app, under `data`
+
+        Examples
+        --------
+        from pipedream import Pipedream
+
+        client = Pipedream(
+            project_id="YOUR_PROJECT_ID",
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.apps.show(
+            project_id="project_id",
+            id="id",
+        )
+        """
+        _response = self._raw_client.show(project_id, id, request_options=request_options)
+        return _response.data
+
+
+class AsyncAppsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAppsClient(client_wrapper=client_wrapper)
+
+    @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
+
+    async def index(
+        self,
+        project_id: str,
+        *,
+        q: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        page: typing.Optional[int] = None,
+        category_name: typing.Optional[str] = None,
+        auth_type: typing.Optional[str] = None,
+        has_components: typing.Optional[str] = None,
+        has_actions: typing.Optional[str] = None,
+        has_triggers: typing.Optional[str] = None,
+        has_private_components: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListResponse:
+        """
+        Parameters
+        ----------
+        project_id : str
+            Project ID (proj_...)
+
+        q : typing.Optional[str]
+
+        limit : typing.Optional[int]
+
+        page : typing.Optional[int]
+
+        category_name : typing.Optional[str]
+
+        auth_type : typing.Optional[str]
+
+        has_components : typing.Optional[str]
+            Component filters, mirroring Rails `V1::AppsController#having_components`:
+            the param's presence selects the filter and its boolean value picks the
+            direction (`false`/`0`/`f`/`off`/empty → apps *without*, anything else →
+            apps *with*). `has_components` means "has actions or triggers". Only the
+            first present of `has_components` > `has_actions` > `has_triggers` applies.
+
+        has_actions : typing.Optional[str]
+
+        has_triggers : typing.Optional[str]
+
+        has_private_components : typing.Optional[str]
+            Not supported yet in the Rust port — Rails uses
+            `PublishedComponentTypesenseSearch.app_slugs_for_owner_keys` here, and
+            we haven't ported that. Returns 501 when set.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListResponse
+            Paginated list of apps
+
+        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.index(
+                project_id="project_id",
+                q="q",
+                limit=1000000,
+                page=1000000,
+                category_name="category_name",
+                auth_type="auth_type",
+                has_components="has_components",
+                has_actions="has_actions",
+                has_triggers="has_triggers",
+                has_private_components="has_private_components",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.index(
+            project_id,
+            q=q,
+            limit=limit,
+            page=page,
+            category_name=category_name,
+            auth_type=auth_type,
+            has_components=has_components,
+            has_actions=has_actions,
+            has_triggers=has_triggers,
+            has_private_components=has_private_components,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def facets(self, project_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+        """
+        Mirrors `V1::AppsController#v2_facets` (`AppTypesenseSearch.facets`):
+        returns `{ data: { category_name: [...], auth_type: [...] } }`.
+
+        Parameters
+        ----------
+        project_id : str
+            Project ID (proj_...)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Any
+            Facet values keyed by field under `data`
+
+        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.facets(
+                project_id="project_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.facets(project_id, request_options=request_options)
+        return _response.data
+
+    async def show(
+        self, project_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Any:
+        """
+        Looks up a single app by hashid (e.g. `app_abc123`) or name_slug (e.g. `github`).
+        If the value starts with `app_` it is treated as a hashid and matched against
+        the document `id` field; otherwise it is matched against `name_slug`.
+
+        Parameters
+        ----------
+        project_id : str
+            Project ID (proj_...)
+
+        id : str
+            App hashid (app_...) or name slug (e.g. github)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Any
+            The app, under `data`
+
+        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.show(
+                project_id="project_id",
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.show(project_id, id, request_options=request_options)
+        return _response.data