vellum-ai 0.7.2__py3-none-any.whl → 0.7.5__py3-none-any.whl

vellum/resources/workflow_deployments/client.py

@@ -1,14 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-import urllib.parse
 from json.decoder import JSONDecodeError
 
 from ...core.api_error import ApiError
 from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.pydantic_utilities import pydantic_v1
-from ...core.remove_none_from_dict import remove_none_from_dict
 from ...core.request_options import RequestOptions
 from ...types.paginated_slim_workflow_deployment_list import PaginatedSlimWorkflowDeploymentList
 from ...types.workflow_deployment_read import WorkflowDeploymentRead
@@ -33,17 +31,32 @@ class WorkflowDeploymentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PaginatedSlimWorkflowDeploymentList:
         """
-        Parameters:
-            - limit: typing.Optional[int]. Number of results to return per page.
+        Used to list all Workflow Deployments.
 
-            - offset: typing.Optional[int]. The initial index from which to return the results.
+        Parameters
+        ----------
+        limit : typing.Optional[int]
+            Number of results to return per page.
 
-            - ordering: typing.Optional[str]. Which field to use when ordering the results.
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
 
-            - status: typing.Optional[WorkflowDeploymentsListRequestStatus]. status
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        status : typing.Optional[WorkflowDeploymentsListRequestStatus]
+            status
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedSlimWorkflowDeploymentList
+
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -52,40 +65,15 @@ class WorkflowDeploymentsClient:
         client.workflow_deployments.list()
         """
         _response = self._client_wrapper.httpx_client.request(
+            "v1/workflow-deployments",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", "v1/workflow-deployments"),
-            params=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "limit": limit,
-                        "offset": offset,
-                        "ordering": ordering,
-                        "status": status,
-                        **(
-                            request_options.get("additional_query_parameters", {})
-                            if request_options is not None
-                            else {}
-                        ),
-                    }
-                )
-            ),
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            params={"limit": limit, "offset": offset, "ordering": ordering, "status": status},
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(PaginatedSlimWorkflowDeploymentList, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(PaginatedSlimWorkflowDeploymentList, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -95,11 +83,21 @@ class WorkflowDeploymentsClient:
         """
         Used to retrieve a workflow deployment given its ID or name.
 
-        Parameters:
-            - id: str. Either the Workflow Deployment's ID or its unique name
+        Parameters
+        ----------
+        id : str
+            Either the Workflow Deployment's ID or its unique name
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowDeploymentRead
+
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -110,30 +108,14 @@ class WorkflowDeploymentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/workflow-deployments/{jsonable_encoder(id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/workflow-deployments/{jsonable_encoder(id)}"
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(WorkflowDeploymentRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(WorkflowDeploymentRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -145,13 +127,24 @@ class WorkflowDeploymentsClient:
         """
         Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment.
 
-        Parameters:
-            - id: str. A UUID string identifying this workflow deployment.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this workflow deployment.
 
-            - name: str. The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve.
+        name : str
+            The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowReleaseTagRead
+
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -163,31 +156,14 @@ class WorkflowDeploymentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/workflow-deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/workflow-deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(WorkflowReleaseTagRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(WorkflowReleaseTagRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -204,15 +180,27 @@ class WorkflowDeploymentsClient:
         """
         Updates an existing Release Tag associated with the specified Workflow Deployment.
 
-        Parameters:
-            - id: str. A UUID string identifying this workflow deployment.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this workflow deployment.
+
+        name : str
+            The name of the Release Tag associated with this Workflow Deployment that you'd like to update.
 
-            - name: str. The name of the Release Tag associated with this Workflow Deployment that you'd like to update.
+        history_item_id : typing.Optional[str]
+            The ID of the Workflow Deployment History Item to tag
 
-            - history_item_id: typing.Optional[str]. The ID of the Workflow Deployment History Item to tag
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Returns
+        -------
+        WorkflowReleaseTagRead
+
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -223,41 +211,17 @@ class WorkflowDeploymentsClient:
             name="name",
         )
         """
-        _request: typing.Dict[str, typing.Any] = {}
-        if history_item_id is not OMIT:
-            _request["history_item_id"] = history_item_id
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/workflow-deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/workflow-deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            json=jsonable_encoder(_request)
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder(_request),
-                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
-            },
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            json={"history_item_id": history_item_id},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(WorkflowReleaseTagRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(WorkflowReleaseTagRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -278,59 +242,57 @@ class AsyncWorkflowDeploymentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PaginatedSlimWorkflowDeploymentList:
         """
-        Parameters:
-            - limit: typing.Optional[int]. Number of results to return per page.
+        Used to list all Workflow Deployments.
+
+        Parameters
+        ----------
+        limit : typing.Optional[int]
+            Number of results to return per page.
 
-            - offset: typing.Optional[int]. The initial index from which to return the results.
+        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.
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
-            - status: typing.Optional[WorkflowDeploymentsListRequestStatus]. status
+        status : typing.Optional[WorkflowDeploymentsListRequestStatus]
+            status
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedSlimWorkflowDeploymentList
+
+
+        Examples
+        --------
+        import asyncio
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.workflow_deployments.list()
+
+
+        async def main() -> None:
+            await client.workflow_deployments.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            "v1/workflow-deployments",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", "v1/workflow-deployments"),
-            params=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "limit": limit,
-                        "offset": offset,
-                        "ordering": ordering,
-                        "status": status,
-                        **(
-                            request_options.get("additional_query_parameters", {})
-                            if request_options is not None
-                            else {}
-                        ),
-                    }
-                )
-            ),
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            params={"limit": limit, "offset": offset, "ordering": ordering, "status": status},
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(PaginatedSlimWorkflowDeploymentList, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(PaginatedSlimWorkflowDeploymentList, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -342,45 +304,47 @@ class AsyncWorkflowDeploymentsClient:
         """
         Used to retrieve a workflow deployment given its ID or name.
 
-        Parameters:
-            - id: str. Either the Workflow Deployment's ID or its unique name
+        Parameters
+        ----------
+        id : str
+            Either the Workflow Deployment's ID or its unique name
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowDeploymentRead
+
+
+        Examples
+        --------
+        import asyncio
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.workflow_deployments.retrieve(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.workflow_deployments.retrieve(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/workflow-deployments/{jsonable_encoder(id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/workflow-deployments/{jsonable_encoder(id)}"
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(WorkflowDeploymentRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(WorkflowDeploymentRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -392,49 +356,51 @@ class AsyncWorkflowDeploymentsClient:
         """
         Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment.
 
-        Parameters:
-            - id: str. A UUID string identifying this workflow deployment.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this workflow deployment.
+
+        name : str
+            The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - name: str. The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve.
+        Returns
+        -------
+        WorkflowReleaseTagRead
+
+
+        Examples
+        --------
+        import asyncio
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.workflow_deployments.retrieve_workflow_release_tag(
-            id="id",
-            name="name",
-        )
+
+
+        async def main() -> None:
+            await client.workflow_deployments.retrieve_workflow_release_tag(
+                id="id",
+                name="name",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/workflow-deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/workflow-deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(WorkflowReleaseTagRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(WorkflowReleaseTagRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -451,60 +417,56 @@ class AsyncWorkflowDeploymentsClient:
         """
         Updates an existing Release Tag associated with the specified Workflow Deployment.
 
-        Parameters:
-            - id: str. A UUID string identifying this workflow deployment.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this workflow deployment.
+
+        name : str
+            The name of the Release Tag associated with this Workflow Deployment that you'd like to update.
+
+        history_item_id : typing.Optional[str]
+            The ID of the Workflow Deployment History Item to tag
 
-            - name: str. The name of the Release Tag associated with this Workflow Deployment that you'd like to update.
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - history_item_id: typing.Optional[str]. The ID of the Workflow Deployment History Item to tag
+        Returns
+        -------
+        WorkflowReleaseTagRead
+
+
+        Examples
+        --------
+        import asyncio
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.workflow_deployments.update_workflow_release_tag(
-            id="id",
-            name="name",
-        )
+
+
+        async def main() -> None:
+            await client.workflow_deployments.update_workflow_release_tag(
+                id="id",
+                name="name",
+            )
+
+
+        asyncio.run(main())
         """
-        _request: typing.Dict[str, typing.Any] = {}
-        if history_item_id is not OMIT:
-            _request["history_item_id"] = history_item_id
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/workflow-deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/workflow-deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            json=jsonable_encoder(_request)
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder(_request),
-                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
-            },
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            json={"history_item_id": history_item_id},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(WorkflowReleaseTagRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(WorkflowReleaseTagRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)