pipedream 2.1.10__tar.gz → 2.1.11__tar.gz

{pipedream-2.1.10 → pipedream-2.1.11}/PKG-INFO

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

{pipedream-2.1.10 → pipedream-2.1.11}/pyproject.toml

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

{pipedream-2.1.10 → pipedream-2.1.11}/src/pipedream/core/client_wrapper.py

@@ -34,12 +34,12 @@ class BaseClientWrapper:
         import platform
 
         headers: typing.Dict[str, str] = {
-            "User-Agent": "pipedream/2.1.10",
+            "User-Agent": "pipedream/2.1.11",
             "X-Fern-Language": "Python",
             "X-Fern-Runtime": f"python/{platform.python_version()}",
             "X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}",
             "X-Fern-SDK-Name": "pipedream",
-            "X-Fern-SDK-Version": "2.1.10",
+            "X-Fern-SDK-Version": "2.1.11",
             **(self.get_custom_headers() or {}),
         }
         if self._project_environment is not None:

{pipedream-2.1.10 → pipedream-2.1.11}/src/pipedream/types/__init__.py

@@ -20,8 +20,13 @@ if typing.TYPE_CHECKING:
     from .backend_client_opts import BackendClientOpts
     from .client_opts import ClientOpts
     from .component import Component
+    from .component_document import ComponentDocument
+    from .component_response import ComponentResponse
     from .component_stash import ComponentStash
     from .component_type import ComponentType
+    from .components_facets_response import ComponentsFacetsResponse
+    from .components_list_response import ComponentsListResponse
+    from .components_page_info import ComponentsPageInfo
     from .configurable_prop import ConfigurableProp
     from .configurable_prop_airtable_base_id import ConfigurablePropAirtableBaseId
     from .configurable_prop_airtable_field_id import ConfigurablePropAirtableFieldId
@@ -164,8 +169,13 @@ _dynamic_imports: typing.Dict[str, str] = {
     "BackendClientOpts": ".backend_client_opts",
     "ClientOpts": ".client_opts",
     "Component": ".component",
+    "ComponentDocument": ".component_document",
+    "ComponentResponse": ".component_response",
     "ComponentStash": ".component_stash",
     "ComponentType": ".component_type",
+    "ComponentsFacetsResponse": ".components_facets_response",
+    "ComponentsListResponse": ".components_list_response",
+    "ComponentsPageInfo": ".components_page_info",
     "ConfigurableProp": ".configurable_prop",
     "ConfigurablePropAirtableBaseId": ".configurable_prop_airtable_base_id",
     "ConfigurablePropAirtableFieldId": ".configurable_prop_airtable_field_id",
@@ -332,8 +342,13 @@ __all__ = [
     "BackendClientOpts",
     "ClientOpts",
     "Component",
+    "ComponentDocument",
+    "ComponentResponse",
     "ComponentStash",
     "ComponentType",
+    "ComponentsFacetsResponse",
+    "ComponentsListResponse",
+    "ComponentsPageInfo",
     "ConfigurableProp",
     "ConfigurablePropAirtableBaseId",
     "ConfigurablePropAirtableFieldId",

pipedream-2.1.11/src/pipedream/types/component_document.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ComponentDocument(UniversalBaseModel):
+    """
+    The documented subset of a v2 components Typesense document. The endpoints
+    return the raw search document, which also carries fields not modeled here
+    (`configurable_props`, `annotations`, `stash`, and the internal
+    `owner_hashid` scoping field); those still appear in the response but are
+    left untyped.
+    """
+
+    app_name_slug: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    `name_slug` of the component's app (e.g. `slack`).
+    """
+
+    component_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    `action` or `source` (trigger).
+    """
+
+    description: typing.Optional[str] = None
+    id: str = pydantic.Field()
+    """
+    Published-component hashid (e.g. `pc_abc123`).
+    """
+
+    key: str = pydantic.Field()
+    """
+    Component key (e.g. `slack-send-message`).
+    """
+
+    name: typing.Optional[str] = None
+    version: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pipedream-2.1.11/src/pipedream/types/component_response.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .component_document import ComponentDocument
+
+
+class ComponentResponse(UniversalBaseModel):
+    """
+    Single-component response envelope: `{ "data": <component> }`.
+    """
+
+    data: ComponentDocument
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pipedream-2.1.11/src/pipedream/types/components_facets_response.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .facet_value import FacetValue
+
+
+class ComponentsFacetsResponse(UniversalBaseModel):
+    """
+    Facets response envelope: `{ "data": { <field>: [{value, count}, ...] } }`,
+    keyed by facet field name (`component_type`, `app_name_slug`). Reuses the
+    shared `FacetValue` bucket registered by the apps handler.
+    """
+
+    data: typing.Dict[str, typing.List[FacetValue]]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pipedream-2.1.11/src/pipedream/types/components_list_response.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .component_document import ComponentDocument
+from .components_page_info import ComponentsPageInfo
+
+
+class ComponentsListResponse(UniversalBaseModel):
+    data: typing.List[ComponentDocument]
+    page_info: ComponentsPageInfo
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pipedream-2.1.11/src/pipedream/types/components_page_info.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ComponentsPageInfo(UniversalBaseModel):
+    count: int
+    page: int
+    per_page: int
+    total_count: int
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

{pipedream-2.1.10 → pipedream-2.1.11}/src/pipedream/v_2/__init__.py

@@ -6,8 +6,8 @@ import typing
 from importlib import import_module
 
 if typing.TYPE_CHECKING:
-    from . import apps
-_dynamic_imports: typing.Dict[str, str] = {"apps": ".apps"}
+    from . import apps, components
+_dynamic_imports: typing.Dict[str, str] = {"apps": ".apps", "components": ".components"}
 
 
 def __getattr__(attr_name: str) -> typing.Any:
@@ -31,4 +31,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["apps"]
+__all__ = ["apps", "components"]

{pipedream-2.1.10 → pipedream-2.1.11}/src/pipedream/v_2/client.py

@@ -9,6 +9,7 @@ from .raw_client import AsyncRawV2Client, RawV2Client
 
 if typing.TYPE_CHECKING:
     from .apps.client import AppsClient, AsyncAppsClient
+    from .components.client import AsyncComponentsClient, ComponentsClient
 
 
 class V2Client:
@@ -16,6 +17,7 @@ class V2Client:
         self._raw_client = RawV2Client(client_wrapper=client_wrapper)
         self._client_wrapper = client_wrapper
         self._apps: typing.Optional[AppsClient] = None
+        self._components: typing.Optional[ComponentsClient] = None
 
     @property
     def with_raw_response(self) -> RawV2Client:
@@ -36,12 +38,21 @@ class V2Client:
             self._apps = AppsClient(client_wrapper=self._client_wrapper)
         return self._apps
 
+    @property
+    def components(self):
+        if self._components is None:
+            from .components.client import ComponentsClient  # noqa: E402
+
+            self._components = ComponentsClient(client_wrapper=self._client_wrapper)
+        return self._components
+
 
 class AsyncV2Client:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._raw_client = AsyncRawV2Client(client_wrapper=client_wrapper)
         self._client_wrapper = client_wrapper
         self._apps: typing.Optional[AsyncAppsClient] = None
+        self._components: typing.Optional[AsyncComponentsClient] = None
 
     @property
     def with_raw_response(self) -> AsyncRawV2Client:
@@ -61,3 +72,11 @@ class AsyncV2Client:
 
             self._apps = AsyncAppsClient(client_wrapper=self._client_wrapper)
         return self._apps
+
+    @property
+    def components(self):
+        if self._components is None:
+            from .components.client import AsyncComponentsClient  # noqa: E402
+
+            self._components = AsyncComponentsClient(client_wrapper=self._client_wrapper)
+        return self._components

pipedream-2.1.11/src/pipedream/v_2/components/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

pipedream-2.1.11/src/pipedream/v_2/components/client.py

@@ -0,0 +1,368 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.component_response import ComponentResponse
+from ...types.components_facets_response import ComponentsFacetsResponse
+from ...types.components_list_response import ComponentsListResponse
+from .raw_client import AsyncRawComponentsClient, RawComponentsClient
+
+
+class ComponentsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawComponentsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawComponentsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawComponentsClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        q: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        page: typing.Optional[int] = None,
+        component_type: typing.Optional[str] = None,
+        app: typing.Optional[str] = None,
+        registry: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ComponentsListResponse:
+        """
+        Parameters
+        ----------
+        q : typing.Optional[str]
+
+        limit : typing.Optional[int]
+
+        page : typing.Optional[int]
+
+        component_type : typing.Optional[str]
+            "actions" | "action" → action; "triggers" | "trigger" → source.
+
+        app : typing.Optional[str]
+            Comma-separated list of app name_slugs (e.g. `slack,github`). Rails
+            also resolves app hashids to slugs here; the Rust port treats values
+            as slugs directly. Passing a hashid will silently filter to zero
+            results.
+
+        registry : typing.Optional[str]
+            `public` (default) | `private` | `all`. Determines whether the scoped
+            search key is generated with just `public` or also the caller's org.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentsListResponse
+            Paginated list of components
+
+        Examples
+        --------
+        from pipedream import Pipedream
+
+        client = Pipedream(
+            project_id="YOUR_PROJECT_ID",
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.v_2.components.list(
+            q="q",
+            limit=1000000,
+            page=1000000,
+            component_type="component_type",
+            app="app",
+            registry="registry",
+        )
+        """
+        _response = self._raw_client.list(
+            q=q,
+            limit=limit,
+            page=page,
+            component_type=component_type,
+            app=app,
+            registry=registry,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def facets(
+        self, *, registry: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> ComponentsFacetsResponse:
+        """
+        Mirrors `V1::Connect::ComponentsController#v2_facets`
+        (`PublishedComponentTypesenseSearch.facets`): returns
+        `{ data: { component_type: [...], app_name_slug: [...] } }`, scoped by the
+        caller's org via a per-request Typesense API key.
+
+        Parameters
+        ----------
+        registry : typing.Optional[str]
+            `public` (default) | `private` | `all` — same semantics as the listing.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentsFacetsResponse
+            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.v_2.components.facets(
+            registry="registry",
+        )
+        """
+        _response = self._raw_client.facets(registry=registry, request_options=request_options)
+        return _response.data
+
+    def retrieve(
+        self, id: str, *, registry: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> ComponentResponse:
+        """
+        Looks up a single published component by hashid (e.g. `pc_abc123`). IDs
+        that don't start with `pc_` return 404. Scoping is enforced via the same
+        per-request scoped Typesense API key as the listing, so private
+        components from other orgs are invisible (404, not 403, to avoid
+        confirming existence).
+
+        Parameters
+        ----------
+        id : str
+            Published-component hashid (pc_...)
+
+        registry : typing.Optional[str]
+            `public` (default) | `private` | `all` — same semantics as the listing.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentResponse
+            The component, 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.v_2.components.retrieve(
+            id="id",
+            registry="registry",
+        )
+        """
+        _response = self._raw_client.retrieve(id, registry=registry, request_options=request_options)
+        return _response.data
+
+
+class AsyncComponentsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawComponentsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawComponentsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawComponentsClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        q: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        page: typing.Optional[int] = None,
+        component_type: typing.Optional[str] = None,
+        app: typing.Optional[str] = None,
+        registry: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ComponentsListResponse:
+        """
+        Parameters
+        ----------
+        q : typing.Optional[str]
+
+        limit : typing.Optional[int]
+
+        page : typing.Optional[int]
+
+        component_type : typing.Optional[str]
+            "actions" | "action" → action; "triggers" | "trigger" → source.
+
+        app : typing.Optional[str]
+            Comma-separated list of app name_slugs (e.g. `slack,github`). Rails
+            also resolves app hashids to slugs here; the Rust port treats values
+            as slugs directly. Passing a hashid will silently filter to zero
+            results.
+
+        registry : typing.Optional[str]
+            `public` (default) | `private` | `all`. Determines whether the scoped
+            search key is generated with just `public` or also the caller's org.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentsListResponse
+            Paginated list of components
+
+        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.v_2.components.list(
+                q="q",
+                limit=1000000,
+                page=1000000,
+                component_type="component_type",
+                app="app",
+                registry="registry",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            q=q,
+            limit=limit,
+            page=page,
+            component_type=component_type,
+            app=app,
+            registry=registry,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def facets(
+        self, *, registry: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> ComponentsFacetsResponse:
+        """
+        Mirrors `V1::Connect::ComponentsController#v2_facets`
+        (`PublishedComponentTypesenseSearch.facets`): returns
+        `{ data: { component_type: [...], app_name_slug: [...] } }`, scoped by the
+        caller's org via a per-request Typesense API key.
+
+        Parameters
+        ----------
+        registry : typing.Optional[str]
+            `public` (default) | `private` | `all` — same semantics as the listing.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentsFacetsResponse
+            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.v_2.components.facets(
+                registry="registry",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.facets(registry=registry, request_options=request_options)
+        return _response.data
+
+    async def retrieve(
+        self, id: str, *, registry: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> ComponentResponse:
+        """
+        Looks up a single published component by hashid (e.g. `pc_abc123`). IDs
+        that don't start with `pc_` return 404. Scoping is enforced via the same
+        per-request scoped Typesense API key as the listing, so private
+        components from other orgs are invisible (404, not 403, to avoid
+        confirming existence).
+
+        Parameters
+        ----------
+        id : str
+            Published-component hashid (pc_...)
+
+        registry : typing.Optional[str]
+            `public` (default) | `private` | `all` — same semantics as the listing.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentResponse
+            The component, 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.v_2.components.retrieve(
+                id="id",
+                registry="registry",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.retrieve(id, registry=registry, request_options=request_options)
+        return _response.data