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

vellum/resources/test_suite_runs/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_test_suite_run_execution_list import PaginatedTestSuiteRunExecutionList
 from ...types.test_suite_run_exec_config_request import TestSuiteRunExecConfigRequest
@@ -32,13 +30,24 @@ class TestSuiteRunsClient:
         """
         Trigger a Test Suite and create a new Test Suite Run
 
-        Parameters:
-            - test_suite_id: str. The ID of the Test Suite to run
+        Parameters
+        ----------
+        test_suite_id : str
+            The ID of the Test Suite to run
 
-            - exec_config: TestSuiteRunExecConfigRequest. Configuration that defines how the Test Suite should be run
+        exec_config : TestSuiteRunExecConfigRequest
+            Configuration that defines how the Test Suite should be run
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TestSuiteRunRead
+
+
+        Examples
+        --------
         from vellum import (
             TestSuiteRunDeploymentReleaseTagExecConfigDataRequest,
             TestSuiteRunExecConfigRequest_DeploymentReleaseTag,
@@ -60,34 +69,16 @@ class TestSuiteRunsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            "v1/test-suite-runs",
+            base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            url=urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", "v1/test-suite-runs"),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            json=jsonable_encoder({"test_suite_id": test_suite_id, "exec_config": exec_config})
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder({"test_suite_id": test_suite_id, "exec_config": exec_config}),
-                **(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={"test_suite_id": test_suite_id, "exec_config": exec_config},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(TestSuiteRunRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(TestSuiteRunRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -97,11 +88,21 @@ class TestSuiteRunsClient:
         """
         Retrieve a specific Test Suite Run by ID
 
-        Parameters:
-            - id: str. A UUID string identifying this test suite run.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this test suite run.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TestSuiteRunRead
+
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -112,30 +113,14 @@ class TestSuiteRunsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/test-suite-runs/{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/test-suite-runs/{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(TestSuiteRunRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(TestSuiteRunRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -151,20 +136,34 @@ class TestSuiteRunsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PaginatedTestSuiteRunExecutionList:
         """
-        Parameters:
-            - id: str. A UUID string identifying this test suite run.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this test suite run.
+
+        expand : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            The response fields to expand for more information.
 
-            - expand: typing.Optional[typing.Union[str, typing.Sequence[str]]]. The response fields to expand for more information.
+            - 'results.metric_results.metric_label' expands the metric label for each metric result.
+            - 'results.metric_results.metric_definition' expands the metric definition for each metric result.
+            - 'results.metric_results.metric_definition.name' expands the metric definition name for each metric result.
 
-                                                                                - 'results.metric_results.metric_label' expands the metric label for each metric result.
-                                                                                - 'results.metric_results.metric_definition' expands the metric definition for each metric result.
-                                                                                - 'results.metric_results.metric_definition.name' expands the metric definition name for each metric result.
-            - limit: typing.Optional[int]. Number of results to return per page.
+        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.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedTestSuiteRunExecutionList
+
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -175,42 +174,15 @@ class TestSuiteRunsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/test-suite-runs/{jsonable_encoder(id)}/executions",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/test-suite-runs/{jsonable_encoder(id)}/executions",
-            ),
-            params=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "expand": expand,
-                        "limit": limit,
-                        "offset": offset,
-                        **(
-                            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={"expand": expand, "limit": limit, "offset": offset},
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(PaginatedTestSuiteRunExecutionList, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(PaginatedTestSuiteRunExecutionList, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -231,13 +203,26 @@ class AsyncTestSuiteRunsClient:
         """
         Trigger a Test Suite and create a new Test Suite Run
 
-        Parameters:
-            - test_suite_id: str. The ID of the Test Suite to run
+        Parameters
+        ----------
+        test_suite_id : str
+            The ID of the Test Suite to run
+
+        exec_config : TestSuiteRunExecConfigRequest
+            Configuration that defines how the Test Suite should be run
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - exec_config: TestSuiteRunExecConfigRequest. Configuration that defines how the Test Suite should be run
+        Returns
+        -------
+        TestSuiteRunRead
+
+
+        Examples
+        --------
+        import asyncio
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
         from vellum import (
             TestSuiteRunDeploymentReleaseTagExecConfigDataRequest,
             TestSuiteRunExecConfigRequest_DeploymentReleaseTag,
@@ -247,46 +232,34 @@ class AsyncTestSuiteRunsClient:
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.test_suite_runs.create(
-            test_suite_id="string",
-            exec_config=TestSuiteRunExecConfigRequest_DeploymentReleaseTag(
-                data=TestSuiteRunDeploymentReleaseTagExecConfigDataRequest(
-                    deployment_id="string",
-                    tag="string",
+
+
+        async def main() -> None:
+            await client.test_suite_runs.create(
+                test_suite_id="string",
+                exec_config=TestSuiteRunExecConfigRequest_DeploymentReleaseTag(
+                    data=TestSuiteRunDeploymentReleaseTagExecConfigDataRequest(
+                        deployment_id="string",
+                        tag="string",
+                    ),
+                    test_case_ids=["string"],
                 ),
-                test_case_ids=["string"],
-            ),
-        )
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            "v1/test-suite-runs",
+            base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            url=urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", "v1/test-suite-runs"),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            json=jsonable_encoder({"test_suite_id": test_suite_id, "exec_config": exec_config})
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder({"test_suite_id": test_suite_id, "exec_config": exec_config}),
-                **(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={"test_suite_id": test_suite_id, "exec_config": exec_config},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(TestSuiteRunRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(TestSuiteRunRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -296,45 +269,47 @@ class AsyncTestSuiteRunsClient:
         """
         Retrieve a specific Test Suite Run by ID
 
-        Parameters:
-            - id: str. A UUID string identifying this test suite run.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this test suite run.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TestSuiteRunRead
+
+
+        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.test_suite_runs.retrieve(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.test_suite_runs.retrieve(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/test-suite-runs/{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/test-suite-runs/{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(TestSuiteRunRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(TestSuiteRunRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -350,66 +325,61 @@ class AsyncTestSuiteRunsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PaginatedTestSuiteRunExecutionList:
         """
-        Parameters:
-            - id: str. A UUID string identifying this test suite run.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this test suite run.
+
+        expand : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            The response fields to expand for more information.
+
+            - 'results.metric_results.metric_label' expands the metric label for each metric result.
+            - 'results.metric_results.metric_definition' expands the metric definition for each metric result.
+            - 'results.metric_results.metric_definition.name' expands the metric definition name for each metric result.
+
+        limit : typing.Optional[int]
+            Number of results to return per page.
 
-            - expand: typing.Optional[typing.Union[str, typing.Sequence[str]]]. The response fields to expand for more information.
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
 
-                                                                                - 'results.metric_results.metric_label' expands the metric label for each metric result.
-                                                                                - 'results.metric_results.metric_definition' expands the metric definition for each metric result.
-                                                                                - 'results.metric_results.metric_definition.name' expands the metric definition name for each metric result.
-            - limit: typing.Optional[int]. Number of results to return per page.
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - offset: typing.Optional[int]. The initial index from which to return the results.
+        Returns
+        -------
+        PaginatedTestSuiteRunExecutionList
+
+
+        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.test_suite_runs.list_executions(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.test_suite_runs.list_executions(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/test-suite-runs/{jsonable_encoder(id)}/executions",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/test-suite-runs/{jsonable_encoder(id)}/executions",
-            ),
-            params=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "expand": expand,
-                        "limit": limit,
-                        "offset": offset,
-                        **(
-                            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={"expand": expand, "limit": limit, "offset": offset},
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(PaginatedTestSuiteRunExecutionList, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(PaginatedTestSuiteRunExecutionList, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)