SDK: docs and improvements (#4310)

skyvern/client/workflows/__init__.py

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

skyvern/client/workflows/client.py

@@ -0,0 +1,127 @@
+# 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 .raw_client import AsyncRawWorkflowsClient, RawWorkflowsClient
+
+
+class WorkflowsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawWorkflowsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawWorkflowsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawWorkflowsClient
+        """
+        return self._raw_client
+
+    def set_workflow_template_status(
+        self, workflow_permanent_id: str, *, is_template: bool, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Dict[str, typing.Optional[typing.Any]]:
+        """
+        Set or unset a workflow as a template.
+
+        Template status is stored at the workflow_permanent_id level (not per-version),
+        meaning all versions of a workflow share the same template status.
+
+        Parameters
+        ----------
+        workflow_permanent_id : str
+
+        is_template : bool
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, typing.Optional[typing.Any]]
+            Successful Response
+
+        Examples
+        --------
+        from skyvern import Skyvern
+
+        client = Skyvern(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflows.set_workflow_template_status(
+            workflow_permanent_id="workflow_permanent_id",
+            is_template=True,
+        )
+        """
+        _response = self._raw_client.set_workflow_template_status(
+            workflow_permanent_id, is_template=is_template, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncWorkflowsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawWorkflowsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawWorkflowsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawWorkflowsClient
+        """
+        return self._raw_client
+
+    async def set_workflow_template_status(
+        self, workflow_permanent_id: str, *, is_template: bool, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Dict[str, typing.Optional[typing.Any]]:
+        """
+        Set or unset a workflow as a template.
+
+        Template status is stored at the workflow_permanent_id level (not per-version),
+        meaning all versions of a workflow share the same template status.
+
+        Parameters
+        ----------
+        workflow_permanent_id : str
+
+        is_template : bool
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, typing.Optional[typing.Any]]
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from skyvern import AsyncSkyvern
+
+        client = AsyncSkyvern(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflows.set_workflow_template_status(
+                workflow_permanent_id="workflow_permanent_id",
+                is_template=True,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.set_workflow_template_status(
+            workflow_permanent_id, is_template=is_template, request_options=request_options
+        )
+        return _response.data

skyvern/client/workflows/raw_client.py

@@ -0,0 +1,136 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+
+
+class RawWorkflowsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def set_workflow_template_status(
+        self, workflow_permanent_id: str, *, is_template: bool, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[typing.Dict[str, typing.Optional[typing.Any]]]:
+        """
+        Set or unset a workflow as a template.
+
+        Template status is stored at the workflow_permanent_id level (not per-version),
+        meaning all versions of a workflow share the same template status.
+
+        Parameters
+        ----------
+        workflow_permanent_id : str
+
+        is_template : bool
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.Dict[str, typing.Optional[typing.Any]]]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/workflows/{jsonable_encoder(workflow_permanent_id)}/template",
+            method="PUT",
+            params={
+                "is_template": is_template,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.Dict[str, typing.Optional[typing.Any]],
+                    parse_obj_as(
+                        type_=typing.Dict[str, typing.Optional[typing.Any]],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawWorkflowsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def set_workflow_template_status(
+        self, workflow_permanent_id: str, *, is_template: bool, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[typing.Dict[str, typing.Optional[typing.Any]]]:
+        """
+        Set or unset a workflow as a template.
+
+        Template status is stored at the workflow_permanent_id level (not per-version),
+        meaning all versions of a workflow share the same template status.
+
+        Parameters
+        ----------
+        workflow_permanent_id : str
+
+        is_template : bool
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.Dict[str, typing.Optional[typing.Any]]]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/workflows/{jsonable_encoder(workflow_permanent_id)}/template",
+            method="PUT",
+            params={
+                "is_template": is_template,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.Dict[str, typing.Optional[typing.Any]],
+                    parse_obj_as(
+                        type_=typing.Dict[str, typing.Optional[typing.Any]],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)