feat(api): deployments

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 16
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-ff8ccba8b5409eaa1128df9027582cb63f66e8accd75e511f70b7c27ef26c9ae.yml
-openapi_spec_hash: 1dbacc339695a7c78718f90f791d3f01
+configured_endpoints: 17
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-2eeb61205775c5997abf8154cd6f6fe81a1e83870eff10050b17ed415aa7860b.yml
+openapi_spec_hash: 63405add4a3f53718f8183cbb8c1a22f
 config_hash: 00ec9df250b9dc077f8d3b93a442d252

api.md

@@ -13,6 +13,7 @@ from kernel.types import (
     DeploymentStateEvent,
     DeploymentCreateResponse,
     DeploymentRetrieveResponse,
+    DeploymentListResponse,
     DeploymentFollowResponse,
 )
 ```
@@ -21,6 +22,7 @@ Methods:
 
 - <code title="post /deployments">client.deployments.<a href="./src/kernel/resources/deployments.py">create</a>(\*\*<a href="src/kernel/types/deployment_create_params.py">params</a>) -> <a href="./src/kernel/types/deployment_create_response.py">DeploymentCreateResponse</a></code>
 - <code title="get /deployments/{id}">client.deployments.<a href="./src/kernel/resources/deployments.py">retrieve</a>(id) -> <a href="./src/kernel/types/deployment_retrieve_response.py">DeploymentRetrieveResponse</a></code>
+- <code title="get /deployments">client.deployments.<a href="./src/kernel/resources/deployments.py">list</a>(\*\*<a href="src/kernel/types/deployment_list_params.py">params</a>) -> <a href="./src/kernel/types/deployment_list_response.py">DeploymentListResponse</a></code>
 - <code title="get /deployments/{id}/events">client.deployments.<a href="./src/kernel/resources/deployments.py">follow</a>(id, \*\*<a href="src/kernel/types/deployment_follow_params.py">params</a>) -> <a href="./src/kernel/types/deployment_follow_response.py">DeploymentFollowResponse</a></code>
 
 # Apps

src/kernel/resources/deployments.py

@@ -7,7 +7,7 @@
 
 import httpx
 
-from ..types import deployment_create_params, deployment_follow_params
+from ..types import deployment_list_params, deployment_create_params, deployment_follow_params
 from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven, FileTypes
 from .._utils import extract_files, maybe_transform, deepcopy_minimal, async_maybe_transform
 from .._compat import cached_property
@@ -20,6 +20,7 @@
 )
 from .._streaming import Stream, AsyncStream
 from .._base_client import make_request_options
+from ..types.deployment_list_response import DeploymentListResponse
 from ..types.deployment_create_response import DeploymentCreateResponse
 from ..types.deployment_follow_response import DeploymentFollowResponse
 from ..types.deployment_retrieve_response import DeploymentRetrieveResponse
@@ -146,6 +147,44 @@ def retrieve(
             cast_to=DeploymentRetrieveResponse,
         )
 
+    def list(
+        self,
+        *,
+        app_name: str | 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,
+    ) -> DeploymentListResponse:
+        """List deployments.
+
+        Optionally filter by application name.
+
+        Args:
+          app_name: Filter results by application name.
+
+          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
+        """
+        return self._get(
+            "/deployments",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"app_name": app_name}, deployment_list_params.DeploymentListParams),
+            ),
+            cast_to=DeploymentListResponse,
+        )
+
     def follow(
         self,
         id: str,
@@ -313,6 +352,44 @@ async def retrieve(
             cast_to=DeploymentRetrieveResponse,
         )
 
+    async def list(
+        self,
+        *,
+        app_name: str | 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,
+    ) -> DeploymentListResponse:
+        """List deployments.
+
+        Optionally filter by application name.
+
+        Args:
+          app_name: Filter results by application name.
+
+          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
+        """
+        return await self._get(
+            "/deployments",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform({"app_name": app_name}, deployment_list_params.DeploymentListParams),
+            ),
+            cast_to=DeploymentListResponse,
+        )
+
     async def follow(
         self,
         id: str,
@@ -371,6 +448,9 @@ def __init__(self, deployments: DeploymentsResource) -> None:
         self.retrieve = to_raw_response_wrapper(
             deployments.retrieve,
         )
+        self.list = to_raw_response_wrapper(
+            deployments.list,
+        )
         self.follow = to_raw_response_wrapper(
             deployments.follow,
         )
@@ -386,6 +466,9 @@ def __init__(self, deployments: AsyncDeploymentsResource) -> None:
         self.retrieve = async_to_raw_response_wrapper(
             deployments.retrieve,
         )
+        self.list = async_to_raw_response_wrapper(
+            deployments.list,
+        )
         self.follow = async_to_raw_response_wrapper(
             deployments.follow,
         )
@@ -401,6 +484,9 @@ def __init__(self, deployments: DeploymentsResource) -> None:
         self.retrieve = to_streamed_response_wrapper(
             deployments.retrieve,
         )
+        self.list = to_streamed_response_wrapper(
+            deployments.list,
+        )
         self.follow = to_streamed_response_wrapper(
             deployments.follow,
         )
@@ -416,6 +502,9 @@ def __init__(self, deployments: AsyncDeploymentsResource) -> None:
         self.retrieve = async_to_streamed_response_wrapper(
             deployments.retrieve,
         )
+        self.list = async_to_streamed_response_wrapper(
+            deployments.list,
+        )
         self.follow = async_to_streamed_response_wrapper(
             deployments.follow,
         )

src/kernel/types/__init__.py

@@ -16,11 +16,13 @@
 from .browser_create_params import BrowserCreateParams as BrowserCreateParams
 from .browser_delete_params import BrowserDeleteParams as BrowserDeleteParams
 from .browser_list_response import BrowserListResponse as BrowserListResponse
+from .deployment_list_params import DeploymentListParams as DeploymentListParams
 from .deployment_state_event import DeploymentStateEvent as DeploymentStateEvent
 from .invocation_state_event import InvocationStateEvent as InvocationStateEvent
 from .browser_create_response import BrowserCreateResponse as BrowserCreateResponse
 from .deployment_create_params import DeploymentCreateParams as DeploymentCreateParams
 from .deployment_follow_params import DeploymentFollowParams as DeploymentFollowParams
+from .deployment_list_response import DeploymentListResponse as DeploymentListResponse
 from .invocation_create_params import InvocationCreateParams as InvocationCreateParams
 from .invocation_update_params import InvocationUpdateParams as InvocationUpdateParams
 from .browser_persistence_param import BrowserPersistenceParam as BrowserPersistenceParam

src/kernel/types/app_list_response.py

@@ -1,9 +1,10 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List, Optional
+from typing import Dict, List
 from typing_extensions import Literal, TypeAlias
 
 from .._models import BaseModel
+from .shared.app_action import AppAction
 
 __all__ = ["AppListResponse", "AppListResponseItem"]
 
@@ -12,20 +13,23 @@ class AppListResponseItem(BaseModel):
     id: str
     """Unique identifier for the app version"""
 
+    actions: List[AppAction]
+    """List of actions available on the app"""
+
     app_name: str
     """Name of the application"""
 
     deployment: str
     """Deployment ID"""
 
+    env_vars: Dict[str, str]
+    """Environment variables configured for this app version"""
+
     region: Literal["aws.us-east-1a"]
     """Deployment region code"""
 
     version: str
     """Version label for the application"""
 
-    env_vars: Optional[Dict[str, str]] = None
-    """Environment variables configured for this app version"""
-
 
 AppListResponse: TypeAlias = List[AppListResponseItem]

src/kernel/types/apps/deployment_create_response.py

@@ -4,13 +4,9 @@
 from typing_extensions import Literal
 
 from ..._models import BaseModel
+from ..shared.app_action import AppAction
 
-__all__ = ["DeploymentCreateResponse", "App", "AppAction"]
-
-
-class AppAction(BaseModel):
-    name: str
-    """Name of the action"""
+__all__ = ["DeploymentCreateResponse", "App"]
 
 
 class App(BaseModel):

src/kernel/types/deployment_list_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["DeploymentListParams"]
+
+
+class DeploymentListParams(TypedDict, total=False):
+    app_name: str
+    """Filter results by application name."""

src/kernel/types/deployment_list_response.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from .._models import BaseModel
+
+__all__ = ["DeploymentListResponse", "DeploymentListResponseItem"]
+
+
+class DeploymentListResponseItem(BaseModel):
+    id: str
+    """Unique identifier for the deployment"""
+
+    created_at: datetime
+    """Timestamp when the deployment was created"""
+
+    region: Literal["aws.us-east-1a"]
+    """Deployment region code"""
+
+    status: Literal["queued", "in_progress", "running", "failed", "stopped"]
+    """Current status of the deployment"""
+
+    entrypoint_rel_path: Optional[str] = None
+    """Relative path to the application entrypoint"""
+
+    env_vars: Optional[Dict[str, str]] = None
+    """Environment variables configured for this deployment"""
+
+    status_reason: Optional[str] = None
+    """Status reason"""
+
+    updated_at: Optional[datetime] = None
+    """Timestamp when the deployment was last updated"""
+
+
+DeploymentListResponse: TypeAlias = List[DeploymentListResponseItem]

tests/api_resources/test_deployments.py

@@ -10,6 +10,7 @@
 from kernel import Kernel, AsyncKernel
 from tests.utils import assert_matches_type
 from kernel.types import (
+    DeploymentListResponse,
     DeploymentCreateResponse,
     DeploymentRetrieveResponse,
 )
@@ -112,6 +113,42 @@ def test_path_params_retrieve(self, client: Kernel) -> None:
                 "",
             )
 
+    @pytest.mark.skip()
+    @parametrize
+    def test_method_list(self, client: Kernel) -> None:
+        deployment = client.deployments.list()
+        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+
+    @pytest.mark.skip()
+    @parametrize
+    def test_method_list_with_all_params(self, client: Kernel) -> None:
+        deployment = client.deployments.list(
+            app_name="app_name",
+        )
+        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+
+    @pytest.mark.skip()
+    @parametrize
+    def test_raw_response_list(self, client: Kernel) -> None:
+        response = client.deployments.with_raw_response.list()
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        deployment = response.parse()
+        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+
+    @pytest.mark.skip()
+    @parametrize
+    def test_streaming_response_list(self, client: Kernel) -> None:
+        with client.deployments.with_streaming_response.list() as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            deployment = response.parse()
+            assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @pytest.mark.skip(
         reason="currently no good way to test endpoints with content type text/event-stream, Prism mock server will fail"
     )
@@ -270,6 +307,42 @@ async def test_path_params_retrieve(self, async_client: AsyncKernel) -> None:
                 "",
             )
 
+    @pytest.mark.skip()
+    @parametrize
+    async def test_method_list(self, async_client: AsyncKernel) -> None:
+        deployment = await async_client.deployments.list()
+        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+
+    @pytest.mark.skip()
+    @parametrize
+    async def test_method_list_with_all_params(self, async_client: AsyncKernel) -> None:
+        deployment = await async_client.deployments.list(
+            app_name="app_name",
+        )
+        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+
+    @pytest.mark.skip()
+    @parametrize
+    async def test_raw_response_list(self, async_client: AsyncKernel) -> None:
+        response = await async_client.deployments.with_raw_response.list()
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        deployment = await response.parse()
+        assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+
+    @pytest.mark.skip()
+    @parametrize
+    async def test_streaming_response_list(self, async_client: AsyncKernel) -> None:
+        async with async_client.deployments.with_streaming_response.list() as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            deployment = await response.parse()
+            assert_matches_type(DeploymentListResponse, deployment, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @pytest.mark.skip(
         reason="currently no good way to test endpoints with content type text/event-stream, Prism mock server will fail"
     )