vellum-ai 0.14.63__py3-none-any.whl → 1.13.5__py3-none-any.whl

vellum/client/resources/integrations/client.py

@@ -0,0 +1,514 @@
+# 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.components_schemas_composio_execute_tool_response import ComponentsSchemasComposioExecuteToolResponse
+from ...types.components_schemas_composio_tool_definition import ComponentsSchemasComposioToolDefinition
+from ...types.integration_read import IntegrationRead
+from ...types.paginated_slim_integration_read_list import PaginatedSlimIntegrationReadList
+from .raw_client import AsyncRawIntegrationsClient, RawIntegrationsClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class IntegrationsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawIntegrationsClient(client_wrapper=client_wrapper)
+
+    @property
+    def _client_wrapper(self) -> SyncClientWrapper:
+        return self._raw_client._client_wrapper
+
+    @property
+    def with_raw_response(self) -> RawIntegrationsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawIntegrationsClient
+        """
+        return self._raw_client
+
+    def retrieve_integration_tool_definition(
+        self,
+        integration_name: str,
+        integration_provider: str,
+        tool_name: str,
+        *,
+        toolkit_version: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ComponentsSchemasComposioToolDefinition:
+        """
+        Parameters
+        ----------
+        integration_name : str
+            The integration name
+
+        integration_provider : str
+            The integration provider name
+
+        tool_name : str
+            The tool's unique name, as specified by the integration provider
+
+        toolkit_version : typing.Optional[str]
+            The version of the toolkit to use. Pass 'latest' to get the latest version, or a specific version string to pin it. If not provided, uses the provider's default.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentsSchemasComposioToolDefinition
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+        client.integrations.retrieve_integration_tool_definition(
+            integration_name="integration_name",
+            integration_provider="integration_provider",
+            tool_name="tool_name",
+        )
+        """
+        _response = self._raw_client.retrieve_integration_tool_definition(
+            integration_name,
+            integration_provider,
+            tool_name,
+            toolkit_version=toolkit_version,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def execute_integration_tool(
+        self,
+        integration_name: str,
+        integration_provider: str,
+        tool_name: str,
+        *,
+        arguments: typing.Dict[str, typing.Optional[typing.Any]],
+        toolkit_version: typing.Optional[str] = OMIT,
+        integration: typing.Optional[str] = OMIT,
+        tool: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ComponentsSchemasComposioExecuteToolResponse:
+        """
+        Parameters
+        ----------
+        integration_name : str
+            The integration name
+
+        integration_provider : str
+            The integration provider name
+
+        tool_name : str
+            The tool's unique name, as specified by the integration provider
+
+        arguments : typing.Dict[str, typing.Optional[typing.Any]]
+
+        toolkit_version : typing.Optional[str]
+
+        integration : typing.Optional[str]
+
+        tool : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentsSchemasComposioExecuteToolResponse
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+        client.integrations.execute_integration_tool(
+            integration_name="integration_name",
+            integration_provider="integration_provider",
+            tool_name="tool_name",
+            arguments={"arguments": {"key": "value"}},
+        )
+        """
+        _response = self._raw_client.execute_integration_tool(
+            integration_name,
+            integration_provider,
+            tool_name,
+            arguments=arguments,
+            toolkit_version=toolkit_version,
+            integration=integration,
+            tool=tool,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def list(
+        self,
+        *,
+        integration_provider: typing.Optional[typing.Literal["COMPOSIO"]] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        search: typing.Optional[str] = None,
+        supports_integration_triggers: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaginatedSlimIntegrationReadList:
+        """
+        List all integrations
+
+        Parameters
+        ----------
+        integration_provider : typing.Optional[typing.Literal["COMPOSIO"]]
+            * `COMPOSIO` - Composio
+
+        limit : typing.Optional[int]
+            Number of results to return per page.
+
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        search : typing.Optional[str]
+            A search term.
+
+        supports_integration_triggers : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedSlimIntegrationReadList
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+        client.integrations.list()
+        """
+        _response = self._raw_client.list(
+            integration_provider=integration_provider,
+            limit=limit,
+            offset=offset,
+            ordering=ordering,
+            search=search,
+            supports_integration_triggers=supports_integration_triggers,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def retrieve(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> IntegrationRead:
+        """
+        Retrieve an integration
+
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this integration.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        IntegrationRead
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+        client.integrations.retrieve(
+            id="id",
+        )
+        """
+        _response = self._raw_client.retrieve(id, request_options=request_options)
+        return _response.data
+
+
+class AsyncIntegrationsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawIntegrationsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawIntegrationsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawIntegrationsClient
+        """
+        return self._raw_client
+
+    async def retrieve_integration_tool_definition(
+        self,
+        integration_name: str,
+        integration_provider: str,
+        tool_name: str,
+        *,
+        toolkit_version: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ComponentsSchemasComposioToolDefinition:
+        """
+        Parameters
+        ----------
+        integration_name : str
+            The integration name
+
+        integration_provider : str
+            The integration provider name
+
+        tool_name : str
+            The tool's unique name, as specified by the integration provider
+
+        toolkit_version : typing.Optional[str]
+            The version of the toolkit to use. Pass 'latest' to get the latest version, or a specific version string to pin it. If not provided, uses the provider's default.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentsSchemasComposioToolDefinition
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.integrations.retrieve_integration_tool_definition(
+                integration_name="integration_name",
+                integration_provider="integration_provider",
+                tool_name="tool_name",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.retrieve_integration_tool_definition(
+            integration_name,
+            integration_provider,
+            tool_name,
+            toolkit_version=toolkit_version,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def execute_integration_tool(
+        self,
+        integration_name: str,
+        integration_provider: str,
+        tool_name: str,
+        *,
+        arguments: typing.Dict[str, typing.Optional[typing.Any]],
+        toolkit_version: typing.Optional[str] = OMIT,
+        integration: typing.Optional[str] = OMIT,
+        tool: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ComponentsSchemasComposioExecuteToolResponse:
+        """
+        Parameters
+        ----------
+        integration_name : str
+            The integration name
+
+        integration_provider : str
+            The integration provider name
+
+        tool_name : str
+            The tool's unique name, as specified by the integration provider
+
+        arguments : typing.Dict[str, typing.Optional[typing.Any]]
+
+        toolkit_version : typing.Optional[str]
+
+        integration : typing.Optional[str]
+
+        tool : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ComponentsSchemasComposioExecuteToolResponse
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.integrations.execute_integration_tool(
+                integration_name="integration_name",
+                integration_provider="integration_provider",
+                tool_name="tool_name",
+                arguments={"arguments": {"key": "value"}},
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.execute_integration_tool(
+            integration_name,
+            integration_provider,
+            tool_name,
+            arguments=arguments,
+            toolkit_version=toolkit_version,
+            integration=integration,
+            tool=tool,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def list(
+        self,
+        *,
+        integration_provider: typing.Optional[typing.Literal["COMPOSIO"]] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        search: typing.Optional[str] = None,
+        supports_integration_triggers: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaginatedSlimIntegrationReadList:
+        """
+        List all integrations
+
+        Parameters
+        ----------
+        integration_provider : typing.Optional[typing.Literal["COMPOSIO"]]
+            * `COMPOSIO` - Composio
+
+        limit : typing.Optional[int]
+            Number of results to return per page.
+
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        search : typing.Optional[str]
+            A search term.
+
+        supports_integration_triggers : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedSlimIntegrationReadList
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.integrations.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            integration_provider=integration_provider,
+            limit=limit,
+            offset=offset,
+            ordering=ordering,
+            search=search,
+            supports_integration_triggers=supports_integration_triggers,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def retrieve(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> IntegrationRead:
+        """
+        Retrieve an integration
+
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this integration.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        IntegrationRead
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.integrations.retrieve(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.retrieve(id, request_options=request_options)
+        return _response.data