feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 36
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-8667763c416101820f5086c97d542bf13bb3bb12b57f5f604da671d9dcea0599.yml
-openapi_spec_hash: e33db883d584bc8573897391f3edb105
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-66a3bf68b47ba61c9b61406d36f614a079ff752b8964a8df8062e485391d5598.yml
+openapi_spec_hash: b17d6cfe3710dd0605078f3907a1a419
 config_hash: 7ec4851ee8d93177947e95df5ae897b5

src/Monitors/MonitorCreateParams.php

@@ -10,25 +10,34 @@
 use ContextDev\Core\Concerns\SdkParams;
 use ContextDev\Core\Contracts\BaseModel;
 use ContextDev\Monitors\MonitorCreateParams\ChangeDetection;
+use ContextDev\Monitors\MonitorCreateParams\ChangeDetection\MonitorsExactChangeDetection;
+use ContextDev\Monitors\MonitorCreateParams\ChangeDetection\MonitorsSemanticChangeDetection;
+use ContextDev\Monitors\MonitorCreateParams\Mode;
 use ContextDev\Monitors\MonitorCreateParams\Schedule;
 use ContextDev\Monitors\MonitorCreateParams\Target;
+use ContextDev\Monitors\MonitorCreateParams\Target\MonitorsExtractTarget;
+use ContextDev\Monitors\MonitorCreateParams\Target\MonitorsPageTarget;
+use ContextDev\Monitors\MonitorCreateParams\Target\MonitorsSitemapTarget;
 use ContextDev\Monitors\MonitorCreateParams\Webhook;
 
 /**
  * Creates a monitor. The request body is a union of the supported target/change detection combinations. The monitor runs immediately after creation to create its initial baseline.
  *
  * @see ContextDev\Services\MonitorsService::create()
  *
+ * @phpstan-import-type ChangeDetectionVariants from \ContextDev\Monitors\MonitorCreateParams\ChangeDetection
+ * @phpstan-import-type TargetVariants from \ContextDev\Monitors\MonitorCreateParams\Target
  * @phpstan-import-type ChangeDetectionShape from \ContextDev\Monitors\MonitorCreateParams\ChangeDetection
  * @phpstan-import-type ScheduleShape from \ContextDev\Monitors\MonitorCreateParams\Schedule
  * @phpstan-import-type TargetShape from \ContextDev\Monitors\MonitorCreateParams\Target
  * @phpstan-import-type WebhookShape from \ContextDev\Monitors\MonitorCreateParams\Webhook
  *
  * @phpstan-type MonitorCreateParamsShape = array{
- *   changeDetection: ChangeDetection|ChangeDetectionShape,
+ *   changeDetection: ChangeDetectionShape,
  *   name: string,
  *   schedule: Schedule|ScheduleShape,
- *   target: Target|TargetShape,
+ *   target: TargetShape,
+ *   mode?: null|Mode|value-of<Mode>,
  *   tags?: list<string>|null,
  *   webhook?: null|Webhook|WebhookShape,
  * }
@@ -40,10 +49,12 @@ final class MonitorCreateParams implements BaseModel
     use SdkParams;
 
     /**
-     * Detect meaning-level changes that match a natural language query.
+     * Discriminated union describing how changes are detected.
+     *
+     * @var ChangeDetectionVariants $changeDetection
      */
-    #[Required('change_detection')]
-    public ChangeDetection $changeDetection;
+    #[Required('change_detection', union: ChangeDetection::class)]
+    public MonitorsExactChangeDetection|MonitorsSemanticChangeDetection $changeDetection;
 
     #[Required]
     public string $name;
@@ -54,8 +65,21 @@ final class MonitorCreateParams implements BaseModel
     #[Required]
     public Schedule $schedule;
 
-    #[Required]
-    public Target $target;
+    /**
+     * Discriminated union describing what the monitor watches.
+     *
+     * @var TargetVariants $target
+     */
+    #[Required(union: Target::class)]
+    public MonitorsPageTarget|MonitorsSitemapTarget|MonitorsExtractTarget $target;
+
+    /**
+     * Top-level monitor category. Always `web` today; the concrete behavior is described by `target` and `change_detection`.
+     *
+     * @var value-of<Mode>|null $mode
+     */
+    #[Optional(enum: Mode::class)]
+    public ?string $mode;
 
     /**
      * User-defined tags for grouping and filtering monitors and their changes.
@@ -98,17 +122,19 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      *
-     * @param ChangeDetection|ChangeDetectionShape $changeDetection
+     * @param ChangeDetectionShape $changeDetection
      * @param Schedule|ScheduleShape $schedule
-     * @param Target|TargetShape $target
+     * @param TargetShape $target
+     * @param Mode|value-of<Mode>|null $mode
      * @param list<string>|null $tags
      * @param Webhook|WebhookShape|null $webhook
      */
     public static function with(
-        ChangeDetection|array $changeDetection,
+        MonitorsExactChangeDetection|array|MonitorsSemanticChangeDetection $changeDetection,
         string $name,
         Schedule|array $schedule,
-        Target|array $target,
+        MonitorsPageTarget|array|MonitorsSitemapTarget|MonitorsExtractTarget $target,
+        Mode|string|null $mode = null,
         ?array $tags = null,
         Webhook|array|null $webhook = null,
     ): self {
@@ -119,19 +145,20 @@ public static function with(
         $self['schedule'] = $schedule;
         $self['target'] = $target;
 
+        null !== $mode && $self['mode'] = $mode;
         null !== $tags && $self['tags'] = $tags;
         null !== $webhook && $self['webhook'] = $webhook;
 
         return $self;
     }
 
     /**
-     * Detect meaning-level changes that match a natural language query.
+     * Discriminated union describing how changes are detected.
      *
-     * @param ChangeDetection|ChangeDetectionShape $changeDetection
+     * @param ChangeDetectionShape $changeDetection
      */
     public function withChangeDetection(
-        ChangeDetection|array $changeDetection
+        MonitorsExactChangeDetection|array|MonitorsSemanticChangeDetection $changeDetection,
     ): self {
         $self = clone $this;
         $self['changeDetection'] = $changeDetection;
@@ -161,16 +188,32 @@ public function withSchedule(Schedule|array $schedule): self
     }
 
     /**
-     * @param Target|TargetShape $target
+     * Discriminated union describing what the monitor watches.
+     *
+     * @param TargetShape $target
      */
-    public function withTarget(Target|array $target): self
-    {
+    public function withTarget(
+        MonitorsPageTarget|array|MonitorsSitemapTarget|MonitorsExtractTarget $target
+    ): self {
         $self = clone $this;
         $self['target'] = $target;
 
         return $self;
     }
 
+    /**
+     * Top-level monitor category. Always `web` today; the concrete behavior is described by `target` and `change_detection`.
+     *
+     * @param Mode|value-of<Mode> $mode
+     */
+    public function withMode(Mode|string $mode): self
+    {
+        $self = clone $this;
+        $self['mode'] = $mode;
+
+        return $self;
+    }
+
     /**
      * User-defined tags for grouping and filtering monitors and their changes.
      *

src/Monitors/MonitorCreateParams/ChangeDetection.php

@@ -4,99 +4,38 @@
 
 namespace ContextDev\Monitors\MonitorCreateParams;
 
-use ContextDev\Core\Attributes\Optional;
-use ContextDev\Core\Attributes\Required;
-use ContextDev\Core\Concerns\SdkModel;
-use ContextDev\Core\Contracts\BaseModel;
-use ContextDev\Monitors\MonitorCreateParams\ChangeDetection\Type;
+use ContextDev\Core\Concerns\SdkUnion;
+use ContextDev\Core\Conversion\Contracts\Converter;
+use ContextDev\Core\Conversion\Contracts\ConverterSource;
+use ContextDev\Monitors\MonitorCreateParams\ChangeDetection\MonitorsExactChangeDetection;
+use ContextDev\Monitors\MonitorCreateParams\ChangeDetection\MonitorsSemanticChangeDetection;
 
 /**
- * Detect meaning-level changes that match a natural language query.
+ * Discriminated union describing how changes are detected.
  *
- * @phpstan-type ChangeDetectionShape = array{
- *   query: string, type: Type|value-of<Type>, confidenceThreshold?: float|null
- * }
+ * @phpstan-import-type MonitorsExactChangeDetectionShape from \ContextDev\Monitors\MonitorCreateParams\ChangeDetection\MonitorsExactChangeDetection
+ * @phpstan-import-type MonitorsSemanticChangeDetectionShape from \ContextDev\Monitors\MonitorCreateParams\ChangeDetection\MonitorsSemanticChangeDetection
+ *
+ * @phpstan-type ChangeDetectionVariants = MonitorsExactChangeDetection|MonitorsSemanticChangeDetection
+ * @phpstan-type ChangeDetectionShape = ChangeDetectionVariants|MonitorsExactChangeDetectionShape|MonitorsSemanticChangeDetectionShape
  */
-final class ChangeDetection implements BaseModel
+final class ChangeDetection implements ConverterSource
 {
-    /** @use SdkModel<ChangeDetectionShape> */
-    use SdkModel;
-
-    #[Required]
-    public string $query;
-
-    /** @var value-of<Type> $type */
-    #[Required(enum: Type::class)]
-    public string $type;
-
-    #[Optional('confidence_threshold')]
-    public ?float $confidenceThreshold;
-
-    /**
-     * `new ChangeDetection()` is missing required properties by the API.
-     *
-     * To enforce required parameters use
-     * ```
-     * ChangeDetection::with(query: ..., type: ...)
-     * ```
-     *
-     * Otherwise ensure the following setters are called
-     *
-     * ```
-     * (new ChangeDetection)->withQuery(...)->withType(...)
-     * ```
-     */
-    public function __construct()
-    {
-        $this->initialize();
-    }
-
-    /**
-     * Construct an instance from the required parameters.
-     *
-     * You must use named parameters to construct any parameters with a default value.
-     *
-     * @param Type|value-of<Type> $type
-     */
-    public static function with(
-        string $query,
-        Type|string $type,
-        ?float $confidenceThreshold = null
-    ): self {
-        $self = new self;
-
-        $self['query'] = $query;
-        $self['type'] = $type;
-
-        null !== $confidenceThreshold && $self['confidenceThreshold'] = $confidenceThreshold;
+    use SdkUnion;
 
-        return $self;
-    }
-
-    public function withQuery(string $query): self
+    public static function discriminator(): string
     {
-        $self = clone $this;
-        $self['query'] = $query;
-
-        return $self;
+        return 'type';
     }
 
     /**
-     * @param Type|value-of<Type> $type
+     * @return list<string|Converter|ConverterSource>|array<string,string|Converter|ConverterSource>
      */
-    public function withType(Type|string $type): self
+    public static function variants(): array
     {
-        $self = clone $this;
-        $self['type'] = $type;
-
-        return $self;
-    }
-
-    public function withConfidenceThreshold(float $confidenceThreshold): self
-    {
-        $self = clone $this;
-        $self['confidenceThreshold'] = $confidenceThreshold;
-
-        return $self;
+        return [
+            'exact' => MonitorsExactChangeDetection::class,
+            'semantic' => MonitorsSemanticChangeDetection::class,
+        ];
     }
 }

src/Monitors/MonitorCreateParams/ChangeDetection/MonitorsExactChangeDetection.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ContextDev\Monitors\MonitorCreateParams\ChangeDetection;
+
+use ContextDev\Core\Attributes\Required;
+use ContextDev\Core\Concerns\SdkModel;
+use ContextDev\Core\Contracts\BaseModel;
+
+/**
+ * Detect exact changes. For page targets, this means visible text diffs. For sitemap targets, this means URL additions and removals.
+ *
+ * @phpstan-type MonitorsExactChangeDetectionShape = array{type: 'exact'}
+ */
+final class MonitorsExactChangeDetection implements BaseModel
+{
+    /** @use SdkModel<MonitorsExactChangeDetectionShape> */
+    use SdkModel;
+
+    /** @var 'exact' $type */
+    #[Required]
+    public string $type = 'exact';
+
+    public function __construct()
+    {
+        $this->initialize();
+    }
+
+    /**
+     * Construct an instance from the required parameters.
+     *
+     * You must use named parameters to construct any parameters with a default value.
+     */
+    public static function with(): self
+    {
+        return new self;
+    }
+
+    /**
+     * @param 'exact' $type
+     */
+    public function withType(string $type): self
+    {
+        $self = clone $this;
+        $self['type'] = $type;
+
+        return $self;
+    }
+}