groundx 2.5.9__py3-none-any.whl → 2.6.0__py3-none-any.whl

groundx/workflow/client.py

@@ -0,0 +1,743 @@
+# 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.message_response import MessageResponse
+from ..types.workflow_response import WorkflowResponse
+from ..types.workflow_steps import WorkflowSteps
+from ..types.workflows_response import WorkflowsResponse
+from .raw_client import AsyncRawWorkflowClient, RawWorkflowClient
+from .types.workflow_get_request_id import WorkflowGetRequestId
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class WorkflowClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawWorkflowClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawWorkflowClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawWorkflowClient
+        """
+        return self._raw_client
+
+    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> WorkflowsResponse:
+        """
+        Get all workflows associated with the API key.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowsResponse
+            Look up success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.list()
+        """
+        _response = self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    def create(
+        self,
+        *,
+        name: typing.Optional[str] = OMIT,
+        steps: typing.Optional[WorkflowSteps] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkflowResponse:
+        """
+        Create a workflow.
+
+        Parameters
+        ----------
+        name : typing.Optional[str]
+            The name of the workflow being created.
+
+        steps : typing.Optional[WorkflowSteps]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowResponse
+            Workflow successfully created
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.create()
+        """
+        _response = self._raw_client.create(name=name, steps=steps, request_options=request_options)
+        return _response.data
+
+    def relationship_add_to_account(
+        self, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> MessageResponse:
+        """
+        Assigns the given workflow to the customer account and is applied by default to all files unless overridden by document or bucket workflows.
+
+        Parameters
+        ----------
+        workflow_id : str
+            The id of the workflow that is being applied.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Apply success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.relationship_add_to_account(
+            workflow_id="workflowId",
+        )
+        """
+        _response = self._raw_client.relationship_add_to_account(
+            workflow_id=workflow_id, request_options=request_options
+        )
+        return _response.data
+
+    def relationship_remove_from_account(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> MessageResponse:
+        """
+        Removes the assigned workflow from the customer account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Apply success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.relationship_remove_from_account()
+        """
+        _response = self._raw_client.relationship_remove_from_account(request_options=request_options)
+        return _response.data
+
+    def relationship_add_to_id(
+        self, id: int, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> MessageResponse:
+        """
+        Assigns the given workflow to the group or bucket and is applied by default to all files unless overridden by document workflows.
+
+        Parameters
+        ----------
+        id : int
+            The id of the group or bucket that the workflow will be assigned to.
+
+        workflow_id : str
+            The id of the workflow that is being applied.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Apply success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.relationship_add_to_id(
+            id=1,
+            workflow_id="workflowId",
+        )
+        """
+        _response = self._raw_client.relationship_add_to_id(
+            id, workflow_id=workflow_id, request_options=request_options
+        )
+        return _response.data
+
+    def relationship_remove_from_id(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> MessageResponse:
+        """
+        Removes the assigned workflow from the customer account.
+
+        Parameters
+        ----------
+        id : int
+            The id of the group or bucket that the workflow will removed from.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Apply success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.relationship_remove_from_id(
+            id=1,
+        )
+        """
+        _response = self._raw_client.relationship_remove_from_id(id, request_options=request_options)
+        return _response.data
+
+    def get(
+        self, id: WorkflowGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> WorkflowResponse:
+        """
+        look up a specific workflow by groupId, bucketId, or workflowId.
+
+        Parameters
+        ----------
+        id : WorkflowGetRequestId
+            The id of the group, bucket, or workflow to look up.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowResponse
+            Look up success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.get(
+            id=1,
+        )
+        """
+        _response = self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    def update(
+        self,
+        id: str,
+        *,
+        workflow_id: str,
+        name: typing.Optional[str] = OMIT,
+        steps: typing.Optional[WorkflowSteps] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkflowResponse:
+        """
+        Update an existing workflow.
+
+        Parameters
+        ----------
+        id : str
+            The workflowId of the workflow being updated.
+
+        workflow_id : str
+            The id of the workflow that is being updated.
+
+        name : typing.Optional[str]
+            The name of the workflow being created.
+
+        steps : typing.Optional[WorkflowSteps]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowResponse
+            Update success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.update(
+            id="id",
+            workflow_id="workflowId",
+        )
+        """
+        _response = self._raw_client.update(
+            id, workflow_id=workflow_id, name=name, steps=steps, request_options=request_options
+        )
+        return _response.data
+
+    def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> MessageResponse:
+        """
+        Delete a workflow.
+
+        Parameters
+        ----------
+        id : str
+            The workflowId of the workflow being deleted.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Delete success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow.delete(
+            id="id",
+        )
+        """
+        _response = self._raw_client.delete(id, request_options=request_options)
+        return _response.data
+
+
+class AsyncWorkflowClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawWorkflowClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawWorkflowClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawWorkflowClient
+        """
+        return self._raw_client
+
+    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> WorkflowsResponse:
+        """
+        Get all workflows associated with the API key.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowsResponse
+            Look up success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    async def create(
+        self,
+        *,
+        name: typing.Optional[str] = OMIT,
+        steps: typing.Optional[WorkflowSteps] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkflowResponse:
+        """
+        Create a workflow.
+
+        Parameters
+        ----------
+        name : typing.Optional[str]
+            The name of the workflow being created.
+
+        steps : typing.Optional[WorkflowSteps]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowResponse
+            Workflow successfully created
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.create()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(name=name, steps=steps, request_options=request_options)
+        return _response.data
+
+    async def relationship_add_to_account(
+        self, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> MessageResponse:
+        """
+        Assigns the given workflow to the customer account and is applied by default to all files unless overridden by document or bucket workflows.
+
+        Parameters
+        ----------
+        workflow_id : str
+            The id of the workflow that is being applied.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Apply success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.relationship_add_to_account(
+                workflow_id="workflowId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.relationship_add_to_account(
+            workflow_id=workflow_id, request_options=request_options
+        )
+        return _response.data
+
+    async def relationship_remove_from_account(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> MessageResponse:
+        """
+        Removes the assigned workflow from the customer account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Apply success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.relationship_remove_from_account()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.relationship_remove_from_account(request_options=request_options)
+        return _response.data
+
+    async def relationship_add_to_id(
+        self, id: int, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> MessageResponse:
+        """
+        Assigns the given workflow to the group or bucket and is applied by default to all files unless overridden by document workflows.
+
+        Parameters
+        ----------
+        id : int
+            The id of the group or bucket that the workflow will be assigned to.
+
+        workflow_id : str
+            The id of the workflow that is being applied.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Apply success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.relationship_add_to_id(
+                id=1,
+                workflow_id="workflowId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.relationship_add_to_id(
+            id, workflow_id=workflow_id, request_options=request_options
+        )
+        return _response.data
+
+    async def relationship_remove_from_id(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> MessageResponse:
+        """
+        Removes the assigned workflow from the customer account.
+
+        Parameters
+        ----------
+        id : int
+            The id of the group or bucket that the workflow will removed from.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Apply success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.relationship_remove_from_id(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.relationship_remove_from_id(id, request_options=request_options)
+        return _response.data
+
+    async def get(
+        self, id: WorkflowGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> WorkflowResponse:
+        """
+        look up a specific workflow by groupId, bucketId, or workflowId.
+
+        Parameters
+        ----------
+        id : WorkflowGetRequestId
+            The id of the group, bucket, or workflow to look up.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowResponse
+            Look up success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(id, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self,
+        id: str,
+        *,
+        workflow_id: str,
+        name: typing.Optional[str] = OMIT,
+        steps: typing.Optional[WorkflowSteps] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkflowResponse:
+        """
+        Update an existing workflow.
+
+        Parameters
+        ----------
+        id : str
+            The workflowId of the workflow being updated.
+
+        workflow_id : str
+            The id of the workflow that is being updated.
+
+        name : typing.Optional[str]
+            The name of the workflow being created.
+
+        steps : typing.Optional[WorkflowSteps]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowResponse
+            Update success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.update(
+                id="id",
+                workflow_id="workflowId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(
+            id, workflow_id=workflow_id, name=name, steps=steps, request_options=request_options
+        )
+        return _response.data
+
+    async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> MessageResponse:
+        """
+        Delete a workflow.
+
+        Parameters
+        ----------
+        id : str
+            The workflowId of the workflow being deleted.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        MessageResponse
+            Delete success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflow.delete(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(id, request_options=request_options)
+        return _response.data