pipedream 2.1.10__tar.gz → 2.1.12__tar.gz

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

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

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

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

{pipedream-2.1.10 → pipedream-2.1.12}/src/pipedream/client.py

@@ -29,7 +29,7 @@ if typing.TYPE_CHECKING:
     from .triggers.client import AsyncTriggersClient, TriggersClient
     from .usage.client import AsyncUsageClient, UsageClient
     from .users.client import AsyncUsersClient, UsersClient
-    from .v_2.client import AsyncV2Client, V2Client
+    from .v2.client import AsyncV2Client, V2Client
 
 
 class Client:
@@ -224,7 +224,7 @@ class Client:
         self._tokens: typing.Optional[TokensClient] = None
         self._usage: typing.Optional[UsageClient] = None
         self._oauth_tokens: typing.Optional[OauthTokensClient] = None
-        self._v_2: typing.Optional[V2Client] = None
+        self._v2: typing.Optional[V2Client] = None
 
     @property
     def app_categories(self):
@@ -347,12 +347,12 @@ class Client:
         return self._oauth_tokens
 
     @property
-    def v_2(self):
-        if self._v_2 is None:
-            from .v_2.client import V2Client  # noqa: E402
+    def v2(self):
+        if self._v2 is None:
+            from .v2.client import V2Client  # noqa: E402
 
-            self._v_2 = V2Client(client_wrapper=self._client_wrapper)
-        return self._v_2
+            self._v2 = V2Client(client_wrapper=self._client_wrapper)
+        return self._v2
 
 
 def _make_default_async_client(
@@ -562,7 +562,7 @@ class AsyncClient:
         self._tokens: typing.Optional[AsyncTokensClient] = None
         self._usage: typing.Optional[AsyncUsageClient] = None
         self._oauth_tokens: typing.Optional[AsyncOauthTokensClient] = None
-        self._v_2: typing.Optional[AsyncV2Client] = None
+        self._v2: typing.Optional[AsyncV2Client] = None
 
     @property
     def app_categories(self):
@@ -685,12 +685,12 @@ class AsyncClient:
         return self._oauth_tokens
 
     @property
-    def v_2(self):
-        if self._v_2 is None:
-            from .v_2.client import AsyncV2Client  # noqa: E402
+    def v2(self):
+        if self._v2 is None:
+            from .v2.client import AsyncV2Client  # noqa: E402
 
-            self._v_2 = AsyncV2Client(client_wrapper=self._client_wrapper)
-        return self._v_2
+            self._v2 = AsyncV2Client(client_wrapper=self._client_wrapper)
+        return self._v2
 
 
 def _get_base_url(*, base_url: typing.Optional[str] = None, environment: PipedreamEnvironment) -> str:

{pipedream-2.1.10 → pipedream-2.1.12}/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.12",
             "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.12",
             **(self.get_custom_headers() or {}),
         }
         if self._project_environment is not None:

{pipedream-2.1.10 → pipedream-2.1.12}/src/pipedream/file_stash/client.py

@@ -23,14 +23,14 @@ class FileStashClient:
         return self._raw_client
 
     def download_file(
-        self, *, s_3_key: str, request_options: typing.Optional[RequestOptions] = None
+        self, *, s3key: str, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.Iterator[bytes]:
         """
         Download a file from File Stash
 
         Parameters
         ----------
-        s_3_key : str
+        s3key : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -50,10 +50,10 @@ class FileStashClient:
             client_secret="YOUR_CLIENT_SECRET",
         )
         client.file_stash.download_file(
-            s_3_key="s3_key",
+            s3key="s3_key",
         )
         """
-        with self._raw_client.download_file(s_3_key=s_3_key, request_options=request_options) as r:
+        with self._raw_client.download_file(s3key=s3key, request_options=request_options) as r:
             yield from r.data
 
 
@@ -73,14 +73,14 @@ class AsyncFileStashClient:
         return self._raw_client
 
     async def download_file(
-        self, *, s_3_key: str, request_options: typing.Optional[RequestOptions] = None
+        self, *, s3key: str, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.AsyncIterator[bytes]:
         """
         Download a file from File Stash
 
         Parameters
         ----------
-        s_3_key : str
+        s3key : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -105,12 +105,12 @@ class AsyncFileStashClient:
 
         async def main() -> None:
             await client.file_stash.download_file(
-                s_3_key="s3_key",
+                s3key="s3_key",
             )
 
 
         asyncio.run(main())
         """
-        async with self._raw_client.download_file(s_3_key=s_3_key, request_options=request_options) as r:
+        async with self._raw_client.download_file(s3key=s3key, request_options=request_options) as r:
             async for _chunk in r.data:
                 yield _chunk

{pipedream-2.1.10 → pipedream-2.1.12}/src/pipedream/file_stash/raw_client.py

@@ -21,14 +21,14 @@ class RawFileStashClient:
 
     @contextlib.contextmanager
     def download_file(
-        self, *, s_3_key: str, request_options: typing.Optional[RequestOptions] = None
+        self, *, s3key: str, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.Iterator[HttpResponse[typing.Iterator[bytes]]]:
         """
         Download a file from File Stash
 
         Parameters
         ----------
-        s_3_key : str
+        s3key : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -42,7 +42,7 @@ class RawFileStashClient:
             f"v1/connect/{encode_path_param(self._client_wrapper._project_id)}/file_stash/download",
             method="GET",
             params={
-                "s3_key": s_3_key,
+                "s3_key": s3key,
             },
             request_options=request_options,
         ) as _response:
@@ -89,14 +89,14 @@ class AsyncRawFileStashClient:
 
     @contextlib.asynccontextmanager
     async def download_file(
-        self, *, s_3_key: str, request_options: typing.Optional[RequestOptions] = None
+        self, *, s3key: str, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]:
         """
         Download a file from File Stash
 
         Parameters
         ----------
-        s_3_key : str
+        s3key : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -110,7 +110,7 @@ class AsyncRawFileStashClient:
             f"v1/connect/{encode_path_param(self._client_wrapper._project_id)}/file_stash/download",
             method="GET",
             params={
-                "s3_key": s_3_key,
+                "s3_key": s3key,
             },
             request_options=request_options,
         ) as _response:

{pipedream-2.1.10 → pipedream-2.1.12}/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.12/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.12/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.12/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.12/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.12/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/src/pipedream/v_2 → pipedream-2.1.12/src/pipedream/v2}/__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/src/pipedream/v_2 → pipedream-2.1.12/src/pipedream/v2}/apps/client.py

@@ -85,7 +85,7 @@ class AppsClient:
             client_id="YOUR_CLIENT_ID",
             client_secret="YOUR_CLIENT_SECRET",
         )
-        client.v_2.apps.list(
+        client.v2.apps.list(
             q="q",
             limit=1000000,
             page=1000000,
@@ -135,7 +135,7 @@ class AppsClient:
             client_id="YOUR_CLIENT_ID",
             client_secret="YOUR_CLIENT_SECRET",
         )
-        client.v_2.apps.facets()
+        client.v2.apps.facets()
         """
         _response = self._raw_client.facets(request_options=request_options)
         return _response.data
@@ -168,7 +168,7 @@ class AppsClient:
             client_id="YOUR_CLIENT_ID",
             client_secret="YOUR_CLIENT_SECRET",
         )
-        client.v_2.apps.retrieve(
+        client.v2.apps.retrieve(
             id="id",
         )
         """
@@ -256,7 +256,7 @@ class AsyncAppsClient:
 
 
         async def main() -> None:
-            await client.v_2.apps.list(
+            await client.v2.apps.list(
                 q="q",
                 limit=1000000,
                 page=1000000,
@@ -314,7 +314,7 @@ class AsyncAppsClient:
 
 
         async def main() -> None:
-            await client.v_2.apps.facets()
+            await client.v2.apps.facets()
 
 
         asyncio.run(main())
@@ -355,7 +355,7 @@ class AsyncAppsClient:
 
 
         async def main() -> None:
-            await client.v_2.apps.retrieve(
+            await client.v2.apps.retrieve(
                 id="id",
             )
 

{pipedream-2.1.10/src/pipedream/v_2 → pipedream-2.1.12/src/pipedream/v2}/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.12/src/pipedream/v2/components/__init__.py

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