feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 29
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-adab8df19dce27396e4a0e698287f083e1f932e63b85fd8dd4d54f80f0e0b5a8.yml
-openapi_spec_hash: 717fea46f446ff97bad627f200963fd7
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-ecf38e27f0c2544a8965f6cee827927343a926e1ab511aa7b34e8aa7d1866c8e.yml
+openapi_spec_hash: c5767791a19b95c52ef073902fa5da77
 config_hash: ff35e224e809656528c44163aa41bebd

src/Monitors/MonitorCreateParams/Webhook.php

@@ -8,21 +8,32 @@
 use ContextDev\Core\Attributes\Required;
 use ContextDev\Core\Concerns\SdkModel;
 use ContextDev\Core\Contracts\BaseModel;
+use ContextDev\Monitors\MonitorCreateParams\Webhook\Event;
 
 /**
- * @phpstan-type WebhookShape = array{url: string, secret?: string|null}
+ * @phpstan-type WebhookShape = array{
+ *   url: string, events?: list<Event|value-of<Event>>|null, secret?: string|null
+ * }
  */
 final class Webhook implements BaseModel
 {
     /** @use SdkModel<WebhookShape> */
     use SdkModel;
 
     /**
-     * Webhook URL called when a change is detected.
+     * Webhook URL events are delivered to.
      */
     #[Required]
     public string $url;
 
+    /**
+     * Events delivered to this endpoint. `change.detected` fires only when a run detects a change; `run.completed` fires on every completed run — including runs that detected no change — and embeds the change when one was detected. Defaults to `["change.detected"]` when omitted.
+     *
+     * @var list<value-of<Event>>|null $events
+     */
+    #[Optional(list: Event::class)]
+    public ?array $events;
+
     /**
      * Signing secret used to verify webhook authenticity. Each delivery includes an `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time compare and reject stale timestamps to prevent replay. Generated by the API; cannot be set by clients.
      */
@@ -52,20 +63,26 @@ public function __construct()
      * Construct an instance from the required parameters.
      *
      * You must use named parameters to construct any parameters with a default value.
+     *
+     * @param list<Event|value-of<Event>>|null $events
      */
-    public static function with(string $url, ?string $secret = null): self
-    {
+    public static function with(
+        string $url,
+        ?array $events = null,
+        ?string $secret = null
+    ): self {
         $self = new self;
 
         $self['url'] = $url;
 
+        null !== $events && $self['events'] = $events;
         null !== $secret && $self['secret'] = $secret;
 
         return $self;
     }
 
     /**
-     * Webhook URL called when a change is detected.
+     * Webhook URL events are delivered to.
      */
     public function withURL(string $url): self
     {
@@ -75,6 +92,19 @@ public function withURL(string $url): self
         return $self;
     }
 
+    /**
+     * Events delivered to this endpoint. `change.detected` fires only when a run detects a change; `run.completed` fires on every completed run — including runs that detected no change — and embeds the change when one was detected. Defaults to `["change.detected"]` when omitted.
+     *
+     * @param list<Event|value-of<Event>> $events
+     */
+    public function withEvents(array $events): self
+    {
+        $self = clone $this;
+        $self['events'] = $events;
+
+        return $self;
+    }
+
     /**
      * Signing secret used to verify webhook authenticity. Each delivery includes an `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time compare and reject stale timestamps to prevent replay. Generated by the API; cannot be set by clients.
      */

src/Monitors/MonitorCreateParams/Webhook/Event.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ContextDev\Monitors\MonitorCreateParams\Webhook;
+
+enum Event: string
+{
+    case CHANGE_DETECTED = 'change.detected';
+
+    case RUN_COMPLETED = 'run.completed';
+}

src/Monitors/MonitorGetResponse/Webhook.php

@@ -8,21 +8,32 @@
 use ContextDev\Core\Attributes\Required;
 use ContextDev\Core\Concerns\SdkModel;
 use ContextDev\Core\Contracts\BaseModel;
+use ContextDev\Monitors\MonitorGetResponse\Webhook\Event;
 
 /**
- * @phpstan-type WebhookShape = array{url: string, secret?: string|null}
+ * @phpstan-type WebhookShape = array{
+ *   url: string, events?: list<Event|value-of<Event>>|null, secret?: string|null
+ * }
  */
 final class Webhook implements BaseModel
 {
     /** @use SdkModel<WebhookShape> */
     use SdkModel;
 
     /**
-     * Webhook URL called when a change is detected.
+     * Webhook URL events are delivered to.
      */
     #[Required]
     public string $url;
 
+    /**
+     * Events delivered to this endpoint. `change.detected` fires only when a run detects a change; `run.completed` fires on every completed run — including runs that detected no change — and embeds the change when one was detected. Defaults to `["change.detected"]` when omitted.
+     *
+     * @var list<value-of<Event>>|null $events
+     */
+    #[Optional(list: Event::class)]
+    public ?array $events;
+
     /**
      * Signing secret used to verify webhook authenticity. Each delivery includes an `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time compare and reject stale timestamps to prevent replay. Generated by the API; cannot be set by clients.
      */
@@ -52,20 +63,26 @@ public function __construct()
      * Construct an instance from the required parameters.
      *
      * You must use named parameters to construct any parameters with a default value.
+     *
+     * @param list<Event|value-of<Event>>|null $events
      */
-    public static function with(string $url, ?string $secret = null): self
-    {
+    public static function with(
+        string $url,
+        ?array $events = null,
+        ?string $secret = null
+    ): self {
         $self = new self;
 
         $self['url'] = $url;
 
+        null !== $events && $self['events'] = $events;
         null !== $secret && $self['secret'] = $secret;
 
         return $self;
     }
 
     /**
-     * Webhook URL called when a change is detected.
+     * Webhook URL events are delivered to.
      */
     public function withURL(string $url): self
     {
@@ -75,6 +92,19 @@ public function withURL(string $url): self
         return $self;
     }
 
+    /**
+     * Events delivered to this endpoint. `change.detected` fires only when a run detects a change; `run.completed` fires on every completed run — including runs that detected no change — and embeds the change when one was detected. Defaults to `["change.detected"]` when omitted.
+     *
+     * @param list<Event|value-of<Event>> $events
+     */
+    public function withEvents(array $events): self
+    {
+        $self = clone $this;
+        $self['events'] = $events;
+
+        return $self;
+    }
+
     /**
      * Signing secret used to verify webhook authenticity. Each delivery includes an `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time compare and reject stale timestamps to prevent replay. Generated by the API; cannot be set by clients.
      */

src/Monitors/MonitorGetResponse/Webhook/Event.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ContextDev\Monitors\MonitorGetResponse\Webhook;
+
+enum Event: string
+{
+    case CHANGE_DETECTED = 'change.detected';
+
+    case RUN_COMPLETED = 'run.completed';
+}

src/Monitors/MonitorListAccountRunsResponse/Data.php

@@ -15,9 +15,11 @@
 use ContextDev\Monitors\MonitorListAccountRunsResponse\Data\Status;
 use ContextDev\Monitors\MonitorListAccountRunsResponse\Data\TargetType;
 use ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery;
+use ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery1;
 
 /**
  * @phpstan-import-type ErrorShape from \ContextDev\Monitors\MonitorListAccountRunsResponse\Data\Error
+ * @phpstan-import-type WebhookDelivery1Shape from \ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery1
  * @phpstan-import-type WebhookDeliveryShape from \ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery
  *
  * @phpstan-type DataShape = array{
@@ -35,6 +37,7 @@
  *   error?: null|Error|ErrorShape,
  *   skipReason?: null|SkipReason|value-of<SkipReason>,
  *   startedAt?: \DateTimeInterface|null,
+ *   webhookDeliveries?: list<WebhookDelivery1|WebhookDelivery1Shape>|null,
  *   webhookDelivery?: null|WebhookDelivery|WebhookDeliveryShape,
  * }
  */
@@ -109,7 +112,17 @@ final class Data implements BaseModel
     public ?\DateTimeInterface $startedAt;
 
     /**
-     * The webhook delivery attempted for a change detected by this run. Omitted when no webhook was attempted, including historical runs created before delivery tracking was added.
+     * All webhook deliveries attempted by this run — one per subscribed event that fired. Omitted when no webhook was attempted, including runs created before event selection was added.
+     *
+     * @var list<WebhookDelivery1>|null $webhookDeliveries
+     */
+    #[Optional('webhook_deliveries', list: WebhookDelivery1::class)]
+    public ?array $webhookDeliveries;
+
+    /**
+     * @deprecated
+     *
+     * Deprecated: use `webhook_deliveries`, which records every attempt now that a run can deliver multiple events. Omitted when no webhook was attempted, including historical runs created before delivery tracking was added.
      */
     #[Optional('webhook_delivery')]
     public ?WebhookDelivery $webhookDelivery;
@@ -163,6 +176,7 @@ public function __construct()
      * @param TargetType|value-of<TargetType> $targetType
      * @param Error|ErrorShape|null $error
      * @param SkipReason|value-of<SkipReason>|null $skipReason
+     * @param list<WebhookDelivery1|WebhookDelivery1Shape>|null $webhookDeliveries
      * @param WebhookDelivery|WebhookDeliveryShape|null $webhookDelivery
      */
     public static function with(
@@ -180,6 +194,7 @@ public static function with(
         Error|array|null $error = null,
         SkipReason|string|null $skipReason = null,
         ?\DateTimeInterface $startedAt = null,
+        ?array $webhookDeliveries = null,
         WebhookDelivery|array|null $webhookDelivery = null,
     ): self {
         $self = new self;
@@ -199,6 +214,7 @@ public static function with(
         null !== $error && $self['error'] = $error;
         null !== $skipReason && $self['skipReason'] = $skipReason;
         null !== $startedAt && $self['startedAt'] = $startedAt;
+        null !== $webhookDeliveries && $self['webhookDeliveries'] = $webhookDeliveries;
         null !== $webhookDelivery && $self['webhookDelivery'] = $webhookDelivery;
 
         return $self;
@@ -348,7 +364,20 @@ public function withStartedAt(?\DateTimeInterface $startedAt): self
     }
 
     /**
-     * The webhook delivery attempted for a change detected by this run. Omitted when no webhook was attempted, including historical runs created before delivery tracking was added.
+     * All webhook deliveries attempted by this run — one per subscribed event that fired. Omitted when no webhook was attempted, including runs created before event selection was added.
+     *
+     * @param list<WebhookDelivery1|WebhookDelivery1Shape> $webhookDeliveries
+     */
+    public function withWebhookDeliveries(array $webhookDeliveries): self
+    {
+        $self = clone $this;
+        $self['webhookDeliveries'] = $webhookDeliveries;
+
+        return $self;
+    }
+
+    /**
+     * Deprecated: use `webhook_deliveries`, which records every attempt now that a run can deliver multiple events. Omitted when no webhook was attempted, including historical runs created before delivery tracking was added.
      *
      * @param WebhookDelivery|WebhookDeliveryShape $webhookDelivery
      */

src/Monitors/MonitorListAccountRunsResponse/Data/WebhookDelivery.php

@@ -8,16 +8,20 @@
 use ContextDev\Core\Concerns\SdkModel;
 use ContextDev\Core\Contracts\BaseModel;
 use ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery\Error;
+use ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery\Event;
 use ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery\Status;
 
 /**
- * The webhook delivery attempted for a change detected by this run. Omitted when no webhook was attempted, including historical runs created before delivery tracking was added.
+ * Deprecated: use `webhook_deliveries`, which records every attempt now that a run can deliver multiple events. Omitted when no webhook was attempted, including historical runs created before delivery tracking was added.
+ *
+ * @deprecated
  *
  * @phpstan-import-type ErrorShape from \ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery\Error
  *
  * @phpstan-type WebhookDeliveryShape = array{
  *   attemptedAt: \DateTimeInterface,
  *   error: null|\ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery\Error|ErrorShape,
+ *   event: Event|value-of<Event>,
  *   eventID: string,
  *   httpStatus: int|null,
  *   status: \ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery\Status|value-of<\ContextDev\Monitors\MonitorListAccountRunsResponse\Data\WebhookDelivery\Status>,
@@ -34,6 +38,14 @@ final class WebhookDelivery implements BaseModel
     #[Required]
     public ?Error $error;
 
+    /**
+     * The event this delivery carried. Deliveries recorded before event selection existed report change.detected.
+     *
+     * @var value-of<Event> $event
+     */
+    #[Required(enum: Event::class)]
+    public string $event;
+
     /**
      * Identifier sent in the X-Context-Id header.
      */
@@ -62,7 +74,12 @@ enum: Status::class,
      * To enforce required parameters use
      * ```
      * WebhookDelivery::with(
-     *   attemptedAt: ..., error: ..., eventID: ..., httpStatus: ..., status: ...
+     *   attemptedAt: ...,
+     *   error: ...,
+     *   event: ...,
+     *   eventID: ...,
+     *   httpStatus: ...,
+     *   status: ...,
      * )
      * ```
      *
@@ -72,6 +89,7 @@ enum: Status::class,
      * (new WebhookDelivery)
      *   ->withAttemptedAt(...)
      *   ->withError(...)
+     *   ->withEvent(...)
      *   ->withEventID(...)
      *   ->withHTTPStatus(...)
      *   ->withStatus(...)
@@ -88,11 +106,13 @@ public function __construct()
      * You must use named parameters to construct any parameters with a default value.
      *
      * @param Error|ErrorShape|null $error
+     * @param Event|value-of<Event> $event
      * @param Status|value-of<Status> $status
      */
     public static function with(
         \DateTimeInterface $attemptedAt,
         Error|array|null $error,
+        Event|string $event,
         string $eventID,
         ?int $httpStatus,
         Status|string $status,
@@ -101,6 +121,7 @@ public static function with(
 
         $self['attemptedAt'] = $attemptedAt;
         $self['error'] = $error;
+        $self['event'] = $event;
         $self['eventID'] = $eventID;
         $self['httpStatus'] = $httpStatus;
         $self['status'] = $status;
@@ -128,6 +149,19 @@ public function withError(
         return $self;
     }
 
+    /**
+     * The event this delivery carried. Deliveries recorded before event selection existed report change.detected.
+     *
+     * @param Event|value-of<Event> $event
+     */
+    public function withEvent(Event|string $event): self
+    {
+        $self = clone $this;
+        $self['event'] = $event;
+
+        return $self;
+    }
+
     /**
      * Identifier sent in the X-Context-Id header.
      */