feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 14
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/miru-ml%2Fmiru-server-7d0dd143c8ea9bc230d9810d8cfb3fde8b1d4eb48295ebf2db7ea67916fb96c3.yml
-openapi_spec_hash: b6667a2e80a356a67bab83f8d5f6e51a
-config_hash: 78c50efd3bbfb4969846973cb0609eff
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/miru-ml%2Fmiru-server-1187ba20c7bd5d91919c6e65f71201c9997541aae5ea6b3068b2e8094b4b8d0c.yml
+openapi_spec_hash: fd892348c3cd6e7ec5bdce4d8134bf14
+config_hash: 1e4fdf81e8b8def15eae344d1f29e513

api.md

@@ -67,3 +67,11 @@ Methods:
 
 - <code title="get /releases/{release_id}">client.releases.<a href="./src/miru_server_sdk/resources/releases.py">retrieve</a>(release_id, \*\*<a href="src/miru_server_sdk/types/release_retrieve_params.py">params</a>) -> <a href="./src/miru_server_sdk/types/release.py">Release</a></code>
 - <code title="get /releases">client.releases.<a href="./src/miru_server_sdk/resources/releases.py">list</a>(\*\*<a href="src/miru_server_sdk/types/release_list_params.py">params</a>) -> <a href="./src/miru_server_sdk/types/release_list_response.py">ReleaseListResponse</a></code>
+
+# Webhooks
+
+Types:
+
+```python
+from miru_server_sdk.types import DeploymentValidateWebhookEvent, UnwrapWebhookEvent
+```

src/miru_server_sdk/_client.py

@@ -21,7 +21,7 @@
 )
 from ._utils import is_given, get_async_library
 from ._version import __version__
-from .resources import devices, releases, deployments, config_instances
+from .resources import devices, releases, webhooks, deployments, config_instances
 from ._streaming import Stream as Stream, AsyncStream as AsyncStream
 from ._exceptions import MiruError, APIStatusError
 from ._base_client import (
@@ -38,6 +38,7 @@ class Miru(SyncAPIClient):
     deployments: deployments.DeploymentsResource
     devices: devices.DevicesResource
     releases: releases.ReleasesResource
+    webhooks: webhooks.WebhooksResource
     with_raw_response: MiruWithRawResponse
     with_streaming_response: MiruWithStreamedResponse
 
@@ -114,6 +115,7 @@ def __init__(
         self.deployments = deployments.DeploymentsResource(self)
         self.devices = devices.DevicesResource(self)
         self.releases = releases.ReleasesResource(self)
+        self.webhooks = webhooks.WebhooksResource(self)
         self.with_raw_response = MiruWithRawResponse(self)
         self.with_streaming_response = MiruWithStreamedResponse(self)
 
@@ -231,6 +233,7 @@ class AsyncMiru(AsyncAPIClient):
     deployments: deployments.AsyncDeploymentsResource
     devices: devices.AsyncDevicesResource
     releases: releases.AsyncReleasesResource
+    webhooks: webhooks.AsyncWebhooksResource
     with_raw_response: AsyncMiruWithRawResponse
     with_streaming_response: AsyncMiruWithStreamedResponse
 
@@ -307,6 +310,7 @@ def __init__(
         self.deployments = deployments.AsyncDeploymentsResource(self)
         self.devices = devices.AsyncDevicesResource(self)
         self.releases = releases.AsyncReleasesResource(self)
+        self.webhooks = webhooks.AsyncWebhooksResource(self)
         self.with_raw_response = AsyncMiruWithRawResponse(self)
         self.with_streaming_response = AsyncMiruWithStreamedResponse(self)
 

src/miru_server_sdk/resources/__init__.py

@@ -16,6 +16,7 @@
     ReleasesResourceWithStreamingResponse,
     AsyncReleasesResourceWithStreamingResponse,
 )
+from .webhooks import WebhooksResource, AsyncWebhooksResource
 from .deployments import (
     DeploymentsResource,
     AsyncDeploymentsResource,
@@ -58,4 +59,6 @@
     "AsyncReleasesResourceWithRawResponse",
     "ReleasesResourceWithStreamingResponse",
     "AsyncReleasesResourceWithStreamingResponse",
+    "WebhooksResource",
+    "AsyncWebhooksResource",
 ]

src/miru_server_sdk/resources/deployments.py

@@ -79,10 +79,10 @@ def create(
           new_config_instances: The _new_ config instances to create for this deployment. A deployment must have
               exactly one config instance for each config schema in the deployment's release.
               If less config instances are provided than the number of schemas, the deployment
-              will 'transfer' config instances its patch source. Archived config instances (in
-              patch sources) cannot be transferred, they must be created anew.
+              will 'transfer' config instances from the deployment it is patched from.
+              Archived config instances cannot be transferred.
 
-          release_id: The ID of the release which this deployment adheres to.
+          release_id: The release ID which this deployment adheres to.
 
           target_status: Desired state of the deployment.
 
@@ -94,15 +94,11 @@ def create(
                 release is the device's current release.
 
               If custom validation is enabled for the release, the deployment must pass
-              validation before fulfilling the target status. Otherwise, the deployment fails
-              and current deployments are unaffected.
+              validation before fulfilling the target status.
 
           expand: The fields to expand in the deployment.
 
-          patch_source_id: The ID of the deployment that this deployment was (optionally) patched from. If
-              no patch source is provided, the deployment is considered to be 'new'-- it is
-              not a delta from an existing deployment. If a patch source is provided, the
-              deployment is considered to be a delta of changes from the patch source.
+          patch_source_id: The ID of the deployment that this deployment was patched from.
 
           extra_headers: Send extra headers
 
@@ -275,8 +271,7 @@ def validate(
           config_instances: The config instance errors for this deployment.
 
           is_valid: Whether the deployment is valid. If invalid, the deployment is immediately
-              archived and marked as 'failed'. If valid, the deployment continues to its
-              desired target status (i.e. 'pending', 'approved', or 'deployed').
+              archived and marked as 'failed'.
 
           message: A message displayed on the deployment level in the UI.
 
@@ -355,10 +350,10 @@ async def create(
           new_config_instances: The _new_ config instances to create for this deployment. A deployment must have
               exactly one config instance for each config schema in the deployment's release.
               If less config instances are provided than the number of schemas, the deployment
-              will 'transfer' config instances its patch source. Archived config instances (in
-              patch sources) cannot be transferred, they must be created anew.
+              will 'transfer' config instances from the deployment it is patched from.
+              Archived config instances cannot be transferred.
 
-          release_id: The ID of the release which this deployment adheres to.
+          release_id: The release ID which this deployment adheres to.
 
           target_status: Desired state of the deployment.
 
@@ -370,15 +365,11 @@ async def create(
                 release is the device's current release.
 
               If custom validation is enabled for the release, the deployment must pass
-              validation before fulfilling the target status. Otherwise, the deployment fails
-              and current deployments are unaffected.
+              validation before fulfilling the target status.
 
           expand: The fields to expand in the deployment.
 
-          patch_source_id: The ID of the deployment that this deployment was (optionally) patched from. If
-              no patch source is provided, the deployment is considered to be 'new'-- it is
-              not a delta from an existing deployment. If a patch source is provided, the
-              deployment is considered to be a delta of changes from the patch source.
+          patch_source_id: The ID of the deployment that this deployment was patched from.
 
           extra_headers: Send extra headers
 
@@ -553,8 +544,7 @@ async def validate(
           config_instances: The config instance errors for this deployment.
 
           is_valid: Whether the deployment is valid. If invalid, the deployment is immediately
-              archived and marked as 'failed'. If valid, the deployment continues to its
-              desired target status (i.e. 'pending', 'approved', or 'deployed').
+              archived and marked as 'failed'.
 
           message: A message displayed on the deployment level in the UI.
 

src/miru_server_sdk/resources/webhooks.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import json
+from typing import cast
+
+from .._models import construct_type
+from .._resource import SyncAPIResource, AsyncAPIResource
+from ..types.unwrap_webhook_event import UnwrapWebhookEvent
+
+__all__ = ["WebhooksResource", "AsyncWebhooksResource"]
+
+
+class WebhooksResource(SyncAPIResource):
+    def unwrap(self, payload: str) -> UnwrapWebhookEvent:
+        return cast(
+            UnwrapWebhookEvent,
+            construct_type(
+                type_=UnwrapWebhookEvent,
+                value=json.loads(payload),
+            ),
+        )
+
+
+class AsyncWebhooksResource(AsyncAPIResource):
+    def unwrap(self, payload: str) -> UnwrapWebhookEvent:
+        return cast(
+            UnwrapWebhookEvent,
+            construct_type(
+                type_=UnwrapWebhookEvent,
+                value=json.loads(payload),
+            ),
+        )

src/miru_server_sdk/types/__init__.py

@@ -17,6 +17,7 @@
 from .device_create_params import DeviceCreateParams as DeviceCreateParams
 from .device_list_response import DeviceListResponse as DeviceListResponse
 from .device_update_params import DeviceUpdateParams as DeviceUpdateParams
+from .unwrap_webhook_event import UnwrapWebhookEvent as UnwrapWebhookEvent
 from .release_list_response import ReleaseListResponse as ReleaseListResponse
 from .deployment_list_params import DeploymentListParams as DeploymentListParams
 from .device_delete_response import DeviceDeleteResponse as DeviceDeleteResponse
@@ -29,6 +30,7 @@
 from .deployment_validate_response import DeploymentValidateResponse as DeploymentValidateResponse
 from .config_instance_list_response import ConfigInstanceListResponse as ConfigInstanceListResponse
 from .config_instance_retrieve_params import ConfigInstanceRetrieveParams as ConfigInstanceRetrieveParams
+from .deployment_validate_webhook_event import DeploymentValidateWebhookEvent as DeploymentValidateWebhookEvent
 from .device_create_activation_token_params import (
     DeviceCreateActivationTokenParams as DeviceCreateActivationTokenParams,
 )

src/miru_server_sdk/types/deployment_create_params.py

@@ -20,13 +20,12 @@ class DeploymentCreateParams(TypedDict, total=False):
 
     A deployment must have exactly one config instance for each config schema in the
     deployment's release. If less config instances are provided than the number of
-    schemas, the deployment will 'transfer' config instances its patch source.
-    Archived config instances (in patch sources) cannot be transferred, they must be
-    created anew.
+    schemas, the deployment will 'transfer' config instances from the deployment it
+    is patched from. Archived config instances cannot be transferred.
     """
 
     release_id: Required[str]
-    """The ID of the release which this deployment adheres to."""
+    """The release ID which this deployment adheres to."""
 
     target_status: Required[Literal["pending", "approved", "deployed"]]
     """Desired state of the deployment.
@@ -39,20 +38,14 @@ class DeploymentCreateParams(TypedDict, total=False):
       release is the device's current release.
 
     If custom validation is enabled for the release, the deployment must pass
-    validation before fulfilling the target status. Otherwise, the deployment fails
-    and current deployments are unaffected.
+    validation before fulfilling the target status.
     """
 
     expand: List[Literal["device", "release", "config_instances"]]
     """The fields to expand in the deployment."""
 
     patch_source_id: str
-    """The ID of the deployment that this deployment was (optionally) patched from.
-
-    If no patch source is provided, the deployment is considered to be 'new'-- it is
-    not a delta from an existing deployment. If a patch source is provided, the
-    deployment is considered to be a delta of changes from the patch source.
-    """
+    """The ID of the deployment that this deployment was patched from."""
 
 
 class NewConfigInstance(TypedDict, total=False):

src/miru_server_sdk/types/deployment_validate_params.py

@@ -17,9 +17,7 @@ class DeploymentValidateParams(TypedDict, total=False):
     is_valid: Required[bool]
     """Whether the deployment is valid.
 
-    If invalid, the deployment is immediately archived and marked as 'failed'. If
-    valid, the deployment continues to its desired target status (i.e. 'pending',
-    'approved', or 'deployed').
+    If invalid, the deployment is immediately archived and marked as 'failed'.
     """
 
     message: Required[str]

src/miru_server_sdk/types/deployment_validate_webhook_event.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["DeploymentValidateWebhookEvent", "Data", "DataDeployment"]
+
+
+class DataDeployment(BaseModel):
+    id: str
+    """ID of the deployment"""
+
+    created_at: datetime
+    """Timestamp of when the device release was created"""
+
+    device_id: str
+    """ID of the device"""
+
+    object: Literal["deployment"]
+
+    release_id: str
+    """The version of the release"""
+
+
+class Data(BaseModel):
+    deployment: DataDeployment
+
+
+class DeploymentValidateWebhookEvent(BaseModel):
+    data: Data
+    """The data associated with the event"""
+
+    object: Literal["event"]
+    """The object that occurred"""
+
+    timestamp: datetime
+    """The timestamp of the event"""
+
+    type: Literal["deployment.validate"]
+    """The type of event"""