feat(api): expose test retrieval endpoint

Author: stainless-app[bot]

.stats.yml

@@ -1,3 +1,3 @@
-configured_endpoints: 16
+configured_endpoints: 17
 openapi_spec_hash: 8827ead72aa0c635ccafac5e008fe247
-config_hash: 0383360784fc87d799bad2be203142b5
+config_hash: 087e6b8013c398a6d24031d24594fdec

api.md

@@ -42,12 +42,13 @@ Methods:
 Types:
 
 ```python
-from openlayer.types.projects import TestCreateResponse
+from openlayer.types.projects import TestCreateResponse, TestListResponse
 ```
 
 Methods:
 
 - <code title="post /projects/{projectId}/tests">client.projects.tests.<a href="./src/openlayer/resources/projects/tests.py">create</a>(project_id, \*\*<a href="src/openlayer/types/projects/test_create_params.py">params</a>) -> <a href="./src/openlayer/types/projects/test_create_response.py">TestCreateResponse</a></code>
+- <code title="get /projects/{projectId}/tests">client.projects.tests.<a href="./src/openlayer/resources/projects/tests.py">list</a>(project_id, \*\*<a href="src/openlayer/types/projects/test_list_params.py">params</a>) -> <a href="./src/openlayer/types/projects/test_list_response.py">TestListResponse</a></code>
 
 # Commits
 

src/openlayer/resources/projects/tests.py

@@ -18,7 +18,8 @@
     async_to_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
-from ...types.projects import test_create_params
+from ...types.projects import test_list_params, test_create_params
+from ...types.projects.test_list_response import TestListResponse
 from ...types.projects.test_create_response import TestCreateResponse
 
 __all__ = ["TestsResource", "AsyncTestsResource"]
@@ -177,6 +178,76 @@ def create(
             cast_to=TestCreateResponse,
         )
 
+    def list(
+        self,
+        project_id: str,
+        *,
+        include_archived: bool | NotGiven = NOT_GIVEN,
+        origin_version_id: Optional[str] | NotGiven = NOT_GIVEN,
+        page: int | NotGiven = NOT_GIVEN,
+        per_page: int | NotGiven = NOT_GIVEN,
+        suggested: bool | NotGiven = NOT_GIVEN,
+        type: Literal["integrity", "consistency", "performance", "fairness", "robustness"] | NotGiven = NOT_GIVEN,
+        uses_production_data: Optional[bool] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> TestListResponse:
+        """
+        List tests under a project.
+
+        Args:
+          include_archived: Filter for archived tests.
+
+          origin_version_id: Retrive tests created by a specific project version.
+
+          page: The page to return in a paginated query.
+
+          per_page: Maximum number of items to return per page.
+
+          suggested: Filter for suggested tests.
+
+          type: Filter objects by test type. Available types are `integrity`, `consistency`,
+              `performance`, `fairness`, and `robustness`.
+
+          uses_production_data: Retrive tests with usesProductionData (monitoring).
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not project_id:
+            raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
+        return self._get(
+            f"/projects/{project_id}/tests",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "include_archived": include_archived,
+                        "origin_version_id": origin_version_id,
+                        "page": page,
+                        "per_page": per_page,
+                        "suggested": suggested,
+                        "type": type,
+                        "uses_production_data": uses_production_data,
+                    },
+                    test_list_params.TestListParams,
+                ),
+            ),
+            cast_to=TestListResponse,
+        )
+
 
 class AsyncTestsResource(AsyncAPIResource):
     @cached_property
@@ -329,6 +400,76 @@ async def create(
             cast_to=TestCreateResponse,
         )
 
+    async def list(
+        self,
+        project_id: str,
+        *,
+        include_archived: bool | NotGiven = NOT_GIVEN,
+        origin_version_id: Optional[str] | NotGiven = NOT_GIVEN,
+        page: int | NotGiven = NOT_GIVEN,
+        per_page: int | NotGiven = NOT_GIVEN,
+        suggested: bool | NotGiven = NOT_GIVEN,
+        type: Literal["integrity", "consistency", "performance", "fairness", "robustness"] | NotGiven = NOT_GIVEN,
+        uses_production_data: Optional[bool] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> TestListResponse:
+        """
+        List tests under a project.
+
+        Args:
+          include_archived: Filter for archived tests.
+
+          origin_version_id: Retrive tests created by a specific project version.
+
+          page: The page to return in a paginated query.
+
+          per_page: Maximum number of items to return per page.
+
+          suggested: Filter for suggested tests.
+
+          type: Filter objects by test type. Available types are `integrity`, `consistency`,
+              `performance`, `fairness`, and `robustness`.
+
+          uses_production_data: Retrive tests with usesProductionData (monitoring).
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not project_id:
+            raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
+        return await self._get(
+            f"/projects/{project_id}/tests",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "include_archived": include_archived,
+                        "origin_version_id": origin_version_id,
+                        "page": page,
+                        "per_page": per_page,
+                        "suggested": suggested,
+                        "type": type,
+                        "uses_production_data": uses_production_data,
+                    },
+                    test_list_params.TestListParams,
+                ),
+            ),
+            cast_to=TestListResponse,
+        )
+
 
 class TestsResourceWithRawResponse:
     __test__ = False
@@ -339,6 +480,9 @@ def __init__(self, tests: TestsResource) -> None:
         self.create = to_raw_response_wrapper(
             tests.create,
         )
+        self.list = to_raw_response_wrapper(
+            tests.list,
+        )
 
 
 class AsyncTestsResourceWithRawResponse:
@@ -348,6 +492,9 @@ def __init__(self, tests: AsyncTestsResource) -> None:
         self.create = async_to_raw_response_wrapper(
             tests.create,
         )
+        self.list = async_to_raw_response_wrapper(
+            tests.list,
+        )
 
 
 class TestsResourceWithStreamingResponse:
@@ -359,6 +506,9 @@ def __init__(self, tests: TestsResource) -> None:
         self.create = to_streamed_response_wrapper(
             tests.create,
         )
+        self.list = to_streamed_response_wrapper(
+            tests.list,
+        )
 
 
 class AsyncTestsResourceWithStreamingResponse:
@@ -368,3 +518,6 @@ def __init__(self, tests: AsyncTestsResource) -> None:
         self.create = async_to_streamed_response_wrapper(
             tests.create,
         )
+        self.list = async_to_streamed_response_wrapper(
+            tests.list,
+        )

src/openlayer/types/projects/__init__.py

@@ -2,8 +2,10 @@
 
 from __future__ import annotations
 
+from .test_list_params import TestListParams as TestListParams
 from .commit_list_params import CommitListParams as CommitListParams
 from .test_create_params import TestCreateParams as TestCreateParams
+from .test_list_response import TestListResponse as TestListResponse
 from .commit_create_params import CommitCreateParams as CommitCreateParams
 from .commit_list_response import CommitListResponse as CommitListResponse
 from .test_create_response import TestCreateResponse as TestCreateResponse

src/openlayer/types/projects/test_list_params.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["TestListParams"]
+
+
+class TestListParams(TypedDict, total=False):
+    include_archived: Annotated[bool, PropertyInfo(alias="includeArchived")]
+    """Filter for archived tests."""
+
+    origin_version_id: Annotated[Optional[str], PropertyInfo(alias="originVersionId")]
+    """Retrive tests created by a specific project version."""
+
+    page: int
+    """The page to return in a paginated query."""
+
+    per_page: Annotated[int, PropertyInfo(alias="perPage")]
+    """Maximum number of items to return per page."""
+
+    suggested: bool
+    """Filter for suggested tests."""
+
+    type: Literal["integrity", "consistency", "performance", "fairness", "robustness"]
+    """Filter objects by test type.
+
+    Available types are `integrity`, `consistency`, `performance`, `fairness`, and
+    `robustness`.
+    """
+
+    uses_production_data: Annotated[Optional[bool], PropertyInfo(alias="usesProductionData")]
+    """Retrive tests with usesProductionData (monitoring)."""