feat(axon): add axon metadata update endpoint

Stainless-Generated-From: 1b2a3b4dd31dde4da80326d1c43c30149c4cbf90

Author: stlc-bot

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 123
+configured_endpoints: 124

api.md

@@ -122,6 +122,7 @@ from runloop_api_client.types import (
     AxonCreateParams,
     AxonEventView,
     AxonListView,
+    AxonUpdateParams,
     AxonView,
     PublishParams,
     PublishResultView,
@@ -132,6 +133,7 @@ Methods:
 
 - <code title="post /v1/axons">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">create</a>(\*\*<a href="src/runloop_api_client/types/axon_create_params.py">params</a>) -> <a href="./src/runloop_api_client/types/axon_view.py">AxonView</a></code>
 - <code title="get /v1/axons/{id}">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">retrieve</a>(id) -> <a href="./src/runloop_api_client/types/axon_view.py">AxonView</a></code>
+- <code title="post /v1/axons/{id}">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">update</a>(id, \*\*<a href="src/runloop_api_client/types/axon_update_params.py">params</a>) -> <a href="./src/runloop_api_client/types/axon_view.py">AxonView</a></code>
 - <code title="get /v1/axons">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">list</a>(\*\*<a href="src/runloop_api_client/types/axon_list_params.py">params</a>) -> <a href="./src/runloop_api_client/types/axon_view.py">SyncAxonsCursorIDPage[AxonView]</a></code>
 - <code title="delete /v1/axons/{id}">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">delete</a>(id) -> object</code>
 - <code title="post /v1/axons/{id}/publish">client.axons.<a href="./src/runloop_api_client/resources/axons/axons.py">publish</a>(id, \*\*<a href="src/runloop_api_client/types/axon_publish_params.py">params</a>) -> <a href="./src/runloop_api_client/types/publish_result_view.py">PublishResultView</a></code>

scripts/mock

@@ -23,7 +23,13 @@
     EventsResourceWithStreamingResponse,
     AsyncEventsResourceWithStreamingResponse,
 )
-from ...types import axon_list_params, axon_create_params, axon_publish_params, axon_subscribe_sse_params
+from ...types import (
+    axon_list_params,
+    axon_create_params,
+    axon_update_params,
+    axon_publish_params,
+    axon_subscribe_sse_params,
+)
 from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
 from ..._utils import path_template, maybe_transform, async_maybe_transform
 from ..._compat import cached_property
@@ -155,6 +161,53 @@ def retrieve(
             cast_to=AxonView,
         )
 
+    def update(
+        self,
+        id: str,
+        *,
+        metadata: Optional[Dict[str, str]] | Omit = omit,
+        # 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,
+        idempotency_key: str | None = None,
+    ) -> AxonView:
+        """[Beta] Updates the specified axon fields.
+
+        Omitted fields are left unchanged. An
+        empty metadata map clears the metadata.
+
+        Args:
+          metadata: User defined metadata to replace the axon metadata. Omit or set to null to leave
+              unchanged, or set to an empty map to clear it.
+
+          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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._post(
+            path_template("/v1/axons/{id}", id=id),
+            body=maybe_transform({"metadata": metadata}, axon_update_params.AxonUpdateParams),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=AxonView,
+        )
+
     def list(
         self,
         *,
@@ -488,6 +541,53 @@ async def retrieve(
             cast_to=AxonView,
         )
 
+    async def update(
+        self,
+        id: str,
+        *,
+        metadata: Optional[Dict[str, str]] | Omit = omit,
+        # 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,
+        idempotency_key: str | None = None,
+    ) -> AxonView:
+        """[Beta] Updates the specified axon fields.
+
+        Omitted fields are left unchanged. An
+        empty metadata map clears the metadata.
+
+        Args:
+          metadata: User defined metadata to replace the axon metadata. Omit or set to null to leave
+              unchanged, or set to an empty map to clear it.
+
+          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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._post(
+            path_template("/v1/axons/{id}", id=id),
+            body=await async_maybe_transform({"metadata": metadata}, axon_update_params.AxonUpdateParams),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=AxonView,
+        )
+
     def list(
         self,
         *,
@@ -720,6 +820,9 @@ def __init__(self, axons: AxonsResource) -> None:
         self.retrieve = to_raw_response_wrapper(
             axons.retrieve,
         )
+        self.update = to_raw_response_wrapper(
+            axons.update,
+        )
         self.list = to_raw_response_wrapper(
             axons.list,
         )
@@ -752,6 +855,9 @@ def __init__(self, axons: AsyncAxonsResource) -> None:
         self.retrieve = async_to_raw_response_wrapper(
             axons.retrieve,
         )
+        self.update = async_to_raw_response_wrapper(
+            axons.update,
+        )
         self.list = async_to_raw_response_wrapper(
             axons.list,
         )
@@ -784,6 +890,9 @@ def __init__(self, axons: AxonsResource) -> None:
         self.retrieve = to_streamed_response_wrapper(
             axons.retrieve,
         )
+        self.update = to_streamed_response_wrapper(
+            axons.update,
+        )
         self.list = to_streamed_response_wrapper(
             axons.list,
         )
@@ -816,6 +925,9 @@ def __init__(self, axons: AsyncAxonsResource) -> None:
         self.retrieve = async_to_streamed_response_wrapper(
             axons.retrieve,
         )
+        self.update = async_to_streamed_response_wrapper(
+            axons.update,
+        )
         self.list = async_to_streamed_response_wrapper(
             axons.list,
         )

src/runloop_api_client/resources/axons/axons.py

@@ -50,6 +50,7 @@
 from .scenario_run_view import ScenarioRunView as ScenarioRunView
 from .allowed_cidr_param import AllowedCidrParam as AllowedCidrParam
 from .axon_create_params import AxonCreateParams as AxonCreateParams
+from .axon_update_params import AxonUpdateParams as AxonUpdateParams
 from .benchmark_job_view import BenchmarkJobView as BenchmarkJobView
 from .benchmark_run_view import BenchmarkRunView as BenchmarkRunView
 from .devbox_list_params import DevboxListParams as DevboxListParams

src/runloop_api_client/types/__init__.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Optional
+from typing_extensions import TypedDict
+
+__all__ = ["AxonUpdateParams"]
+
+
+class AxonUpdateParams(TypedDict, total=False):
+    metadata: Optional[Dict[str, str]]
+    """User defined metadata to replace the axon metadata.
+
+    Omit or set to null to leave unchanged, or set to an empty map to clear it.
+    """

src/runloop_api_client/types/axon_update_params.py

@@ -92,6 +92,52 @@ def test_path_params_retrieve(self, client: Runloop) -> None:
                 "",
             )
 
+    @parametrize
+    def test_method_update(self, client: Runloop) -> None:
+        axon = client.axons.update(
+            id="id",
+        )
+        assert_matches_type(AxonView, axon, path=["response"])
+
+    @parametrize
+    def test_method_update_with_all_params(self, client: Runloop) -> None:
+        axon = client.axons.update(
+            id="id",
+            metadata={"foo": "string"},
+        )
+        assert_matches_type(AxonView, axon, path=["response"])
+
+    @parametrize
+    def test_raw_response_update(self, client: Runloop) -> None:
+        response = client.axons.with_raw_response.update(
+            id="id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        axon = response.parse()
+        assert_matches_type(AxonView, axon, path=["response"])
+
+    @parametrize
+    def test_streaming_response_update(self, client: Runloop) -> None:
+        with client.axons.with_streaming_response.update(
+            id="id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            axon = response.parse()
+            assert_matches_type(AxonView, axon, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    def test_path_params_update(self, client: Runloop) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            client.axons.with_raw_response.update(
+                id="",
+            )
+
     @parametrize
     def test_method_list(self, client: Runloop) -> None:
         axon = client.axons.list()
@@ -345,6 +391,52 @@ async def test_path_params_retrieve(self, async_client: AsyncRunloop) -> None:
                 "",
             )
 
+    @parametrize
+    async def test_method_update(self, async_client: AsyncRunloop) -> None:
+        axon = await async_client.axons.update(
+            id="id",
+        )
+        assert_matches_type(AxonView, axon, path=["response"])
+
+    @parametrize
+    async def test_method_update_with_all_params(self, async_client: AsyncRunloop) -> None:
+        axon = await async_client.axons.update(
+            id="id",
+            metadata={"foo": "string"},
+        )
+        assert_matches_type(AxonView, axon, path=["response"])
+
+    @parametrize
+    async def test_raw_response_update(self, async_client: AsyncRunloop) -> None:
+        response = await async_client.axons.with_raw_response.update(
+            id="id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        axon = await response.parse()
+        assert_matches_type(AxonView, axon, path=["response"])
+
+    @parametrize
+    async def test_streaming_response_update(self, async_client: AsyncRunloop) -> None:
+        async with async_client.axons.with_streaming_response.update(
+            id="id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            axon = await response.parse()
+            assert_matches_type(AxonView, axon, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    async def test_path_params_update(self, async_client: AsyncRunloop) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            await async_client.axons.with_raw_response.update(
+                id="",
+            )
+
     @parametrize
     async def test_method_list(self, async_client: AsyncRunloop) -> None:
         axon = await async_client.axons.list()