feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,3 +1,3 @@
-configured_endpoints: 55
+configured_endpoints: 56
 openapi_spec_hash: 12260ab88069ff15d254606e041debfb
-config_hash: bed87752f4056d0c4bf2ddf856307800
+config_hash: 6c3ad84d97bf1d0989ad2ec0cae64078

api.md

@@ -206,6 +206,7 @@ from codex.types.projects import (
     QueryLogListByGroupResponse,
     QueryLogListGroupsResponse,
     QueryLogStartRemediationResponse,
+    QueryLogUpdateMetadataResponse,
 )
 ```
 
@@ -217,6 +218,7 @@ Methods:
 - <code title="get /api/projects/{project_id}/query_logs/logs_by_group">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">list_by_group</a>(project_id, \*\*<a href="src/codex/types/projects/query_log_list_by_group_params.py">params</a>) -> <a href="./src/codex/types/projects/query_log_list_by_group_response.py">QueryLogListByGroupResponse</a></code>
 - <code title="get /api/projects/{project_id}/query_logs/groups">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">list_groups</a>(project_id, \*\*<a href="src/codex/types/projects/query_log_list_groups_params.py">params</a>) -> <a href="./src/codex/types/projects/query_log_list_groups_response.py">SyncOffsetPageQueryLogGroups[QueryLogListGroupsResponse]</a></code>
 - <code title="post /api/projects/{project_id}/query_logs/{query_log_id}/start_remediation">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">start_remediation</a>(query_log_id, \*, project_id) -> <a href="./src/codex/types/projects/query_log_start_remediation_response.py">QueryLogStartRemediationResponse</a></code>
+- <code title="put /api/projects/{project_id}/query_logs/{query_log_id}/metadata">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">update_metadata</a>(query_log_id, \*, project_id, \*\*<a href="src/codex/types/projects/query_log_update_metadata_params.py">params</a>) -> <a href="./src/codex/types/projects/query_log_update_metadata_response.py">QueryLogUpdateMetadataResponse</a></code>
 
 ## Remediations
 

src/codex/resources/projects/query_logs.py

@@ -29,12 +29,14 @@
     query_log_list_params,
     query_log_list_groups_params,
     query_log_list_by_group_params,
+    query_log_update_metadata_params,
     query_log_add_user_feedback_params,
 )
 from ...types.projects.query_log_list_response import QueryLogListResponse
 from ...types.projects.query_log_retrieve_response import QueryLogRetrieveResponse
 from ...types.projects.query_log_list_groups_response import QueryLogListGroupsResponse
 from ...types.projects.query_log_list_by_group_response import QueryLogListByGroupResponse
+from ...types.projects.query_log_update_metadata_response import QueryLogUpdateMetadataResponse
 from ...types.projects.query_log_add_user_feedback_response import QueryLogAddUserFeedbackResponse
 from ...types.projects.query_log_start_remediation_response import QueryLogStartRemediationResponse
 
@@ -464,6 +466,44 @@ def start_remediation(
             cast_to=QueryLogStartRemediationResponse,
         )
 
+    def update_metadata(
+        self,
+        query_log_id: str,
+        *,
+        project_id: str,
+        body: object,
+        # 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,
+    ) -> QueryLogUpdateMetadataResponse:
+        """
+        Update Metadata Route
+
+        Args:
+          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}")
+        if not query_log_id:
+            raise ValueError(f"Expected a non-empty value for `query_log_id` but received {query_log_id!r}")
+        return self._put(
+            f"/api/projects/{project_id}/query_logs/{query_log_id}/metadata",
+            body=maybe_transform(body, query_log_update_metadata_params.QueryLogUpdateMetadataParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=QueryLogUpdateMetadataResponse,
+        )
+
 
 class AsyncQueryLogsResource(AsyncAPIResource):
     @cached_property
@@ -890,6 +930,44 @@ async def start_remediation(
             cast_to=QueryLogStartRemediationResponse,
         )
 
+    async def update_metadata(
+        self,
+        query_log_id: str,
+        *,
+        project_id: str,
+        body: object,
+        # 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,
+    ) -> QueryLogUpdateMetadataResponse:
+        """
+        Update Metadata Route
+
+        Args:
+          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}")
+        if not query_log_id:
+            raise ValueError(f"Expected a non-empty value for `query_log_id` but received {query_log_id!r}")
+        return await self._put(
+            f"/api/projects/{project_id}/query_logs/{query_log_id}/metadata",
+            body=await async_maybe_transform(body, query_log_update_metadata_params.QueryLogUpdateMetadataParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=QueryLogUpdateMetadataResponse,
+        )
+
 
 class QueryLogsResourceWithRawResponse:
     def __init__(self, query_logs: QueryLogsResource) -> None:
@@ -913,6 +991,9 @@ def __init__(self, query_logs: QueryLogsResource) -> None:
         self.start_remediation = to_raw_response_wrapper(
             query_logs.start_remediation,
         )
+        self.update_metadata = to_raw_response_wrapper(
+            query_logs.update_metadata,
+        )
 
 
 class AsyncQueryLogsResourceWithRawResponse:
@@ -937,6 +1018,9 @@ def __init__(self, query_logs: AsyncQueryLogsResource) -> None:
         self.start_remediation = async_to_raw_response_wrapper(
             query_logs.start_remediation,
         )
+        self.update_metadata = async_to_raw_response_wrapper(
+            query_logs.update_metadata,
+        )
 
 
 class QueryLogsResourceWithStreamingResponse:
@@ -961,6 +1045,9 @@ def __init__(self, query_logs: QueryLogsResource) -> None:
         self.start_remediation = to_streamed_response_wrapper(
             query_logs.start_remediation,
         )
+        self.update_metadata = to_streamed_response_wrapper(
+            query_logs.update_metadata,
+        )
 
 
 class AsyncQueryLogsResourceWithStreamingResponse:
@@ -985,3 +1072,6 @@ def __init__(self, query_logs: AsyncQueryLogsResource) -> None:
         self.start_remediation = async_to_streamed_response_wrapper(
             query_logs.start_remediation,
         )
+        self.update_metadata = async_to_streamed_response_wrapper(
+            query_logs.update_metadata,
+        )

src/codex/types/projects/__init__.py

@@ -26,8 +26,10 @@
 from .query_log_list_groups_response import QueryLogListGroupsResponse as QueryLogListGroupsResponse
 from .remediation_edit_answer_params import RemediationEditAnswerParams as RemediationEditAnswerParams
 from .query_log_list_by_group_response import QueryLogListByGroupResponse as QueryLogListByGroupResponse
+from .query_log_update_metadata_params import QueryLogUpdateMetadataParams as QueryLogUpdateMetadataParams
 from .remediation_edit_answer_response import RemediationEditAnswerResponse as RemediationEditAnswerResponse
 from .query_log_add_user_feedback_params import QueryLogAddUserFeedbackParams as QueryLogAddUserFeedbackParams
+from .query_log_update_metadata_response import QueryLogUpdateMetadataResponse as QueryLogUpdateMetadataResponse
 from .query_log_add_user_feedback_response import QueryLogAddUserFeedbackResponse as QueryLogAddUserFeedbackResponse
 from .query_log_start_remediation_response import QueryLogStartRemediationResponse as QueryLogStartRemediationResponse
 from .remediation_edit_draft_answer_params import RemediationEditDraftAnswerParams as RemediationEditDraftAnswerParams

src/codex/types/projects/query_log_update_metadata_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["QueryLogUpdateMetadataParams"]
+
+
+class QueryLogUpdateMetadataParams(TypedDict, total=False):
+    project_id: Required[str]
+
+    body: Required[object]

src/codex/types/projects/query_log_update_metadata_response.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["QueryLogUpdateMetadataResponse"]
+
+
+class QueryLogUpdateMetadataResponse(BaseModel):
+    id: str
+
+    custom_metadata: Optional[object] = None
+    """Arbitrary metadata supplied by the user/system"""
+
+    custom_metadata_keys: Optional[List[str]] = None
+    """Keys of the custom metadata"""

tests/api_resources/projects/test_query_logs.py

@@ -21,6 +21,7 @@
     QueryLogRetrieveResponse,
     QueryLogListGroupsResponse,
     QueryLogListByGroupResponse,
+    QueryLogUpdateMetadataResponse,
     QueryLogAddUserFeedbackResponse,
     QueryLogStartRemediationResponse,
 )
@@ -387,6 +388,63 @@ def test_path_params_start_remediation(self, client: Codex) -> None:
                 project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             )
 
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_update_metadata(self, client: Codex) -> None:
+        query_log = client.projects.query_logs.update_metadata(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            body={},
+        )
+        assert_matches_type(QueryLogUpdateMetadataResponse, query_log, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_raw_response_update_metadata(self, client: Codex) -> None:
+        response = client.projects.query_logs.with_raw_response.update_metadata(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            body={},
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        query_log = response.parse()
+        assert_matches_type(QueryLogUpdateMetadataResponse, query_log, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_streaming_response_update_metadata(self, client: Codex) -> None:
+        with client.projects.query_logs.with_streaming_response.update_metadata(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            body={},
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            query_log = response.parse()
+            assert_matches_type(QueryLogUpdateMetadataResponse, query_log, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_path_params_update_metadata(self, client: Codex) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `project_id` but received ''"):
+            client.projects.query_logs.with_raw_response.update_metadata(
+                query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+                project_id="",
+                body={},
+            )
+
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `query_log_id` but received ''"):
+            client.projects.query_logs.with_raw_response.update_metadata(
+                query_log_id="",
+                project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+                body={},
+            )
+
 
 class TestAsyncQueryLogs:
     parametrize = pytest.mark.parametrize(
@@ -748,3 +806,60 @@ async def test_path_params_start_remediation(self, async_client: AsyncCodex) ->
                 query_log_id="",
                 project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             )
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_update_metadata(self, async_client: AsyncCodex) -> None:
+        query_log = await async_client.projects.query_logs.update_metadata(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            body={},
+        )
+        assert_matches_type(QueryLogUpdateMetadataResponse, query_log, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_raw_response_update_metadata(self, async_client: AsyncCodex) -> None:
+        response = await async_client.projects.query_logs.with_raw_response.update_metadata(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            body={},
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        query_log = await response.parse()
+        assert_matches_type(QueryLogUpdateMetadataResponse, query_log, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_streaming_response_update_metadata(self, async_client: AsyncCodex) -> None:
+        async with async_client.projects.query_logs.with_streaming_response.update_metadata(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            body={},
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            query_log = await response.parse()
+            assert_matches_type(QueryLogUpdateMetadataResponse, query_log, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_path_params_update_metadata(self, async_client: AsyncCodex) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `project_id` but received ''"):
+            await async_client.projects.query_logs.with_raw_response.update_metadata(
+                query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+                project_id="",
+                body={},
+            )
+
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `query_log_id` but received ''"):
+            await async_client.projects.query_logs.with_raw_response.update_metadata(
+                query_log_id="",
+                project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+                body={},
+            )