feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 25
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-a4f78808dc23a76896b451576b3b44b0d663977f2032eaed0271dd386b20c43c.yml
-openapi_spec_hash: 01f9e1ae0d635f8b874f48e3ba461476
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-021b48afe1d6e3f54c4ebe3d0da4beb3fb8b69a6d384a4aeadbc5bab7f967603.yml
+openapi_spec_hash: 2aa5b59d78c708b094acf29cc0d9a68a
 config_hash: c7b0cdaba3b9797b77efd89e1754d803

src/ServiceContracts/WebContract.php

@@ -10,8 +10,8 @@
 use ContextDev\Web\WebExtractFontsResponse;
 use ContextDev\Web\WebExtractParams\Pdf;
 use ContextDev\Web\WebExtractResponse;
+use ContextDev\Web\WebExtractStyleguideParams\ColorScheme;
 use ContextDev\Web\WebExtractStyleguideResponse;
-use ContextDev\Web\WebScreenshotParams\ColorScheme;
 use ContextDev\Web\WebScreenshotParams\Country;
 use ContextDev\Web\WebScreenshotParams\FullScreenshot;
 use ContextDev\Web\WebScreenshotParams\HandleCookiePopup;
@@ -116,6 +116,7 @@ public function extractFonts(
     /**
      * @api
      *
+     * @param ColorScheme|value-of<ColorScheme> $colorScheme Optional browser color scheme to emulate for websites that respond to prefers-color-scheme. This value is part of the styleguide cache key.
      * @param string $directURL A specific URL to fetch the styleguide from directly, bypassing domain resolution (e.g., 'https://example.com/design-system'). When provided, the styleguide is extracted from this exact URL. You must provide either 'domain' or 'directUrl', but not both.
      * @param string $domain Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both.
      * @param int $maxAgeMs Maximum age in milliseconds for cached data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 year.
@@ -125,6 +126,7 @@ public function extractFonts(
      * @throws APIException
      */
     public function extractStyleguide(
+        ColorScheme|string|null $colorScheme = null,
         ?string $directURL = null,
         ?string $domain = null,
         int $maxAgeMs = 7776000000,
@@ -135,7 +137,7 @@ public function extractStyleguide(
     /**
      * @api
      *
-     * @param ColorScheme|value-of<ColorScheme> $colorScheme Optional parameter to choose the site's visual theme in the screenshot. Use 'light' or 'dark' when the site offers both appearances.
+     * @param \ContextDev\Web\WebScreenshotParams\ColorScheme|value-of<\ContextDev\Web\WebScreenshotParams\ColorScheme> $colorScheme Optional parameter to choose the site's visual theme in the screenshot. Use 'light' or 'dark' when the site offers both appearances.
      * @param Country|value-of<Country> $country Two-letter ISO 3166-1 alpha-2 country code for the website request location. When provided, Context.dev fetches the target page from that country.
      * @param string $directURL A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https://example.com/pricing'). When provided, the screenshot is taken of this exact URL. You must provide either 'domain' or 'directUrl', but not both.
      * @param string $domain Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both.
@@ -152,7 +154,7 @@ public function extractStyleguide(
      * @throws APIException
      */
     public function screenshot(
-        ColorScheme|string|null $colorScheme = null,
+        \ContextDev\Web\WebScreenshotParams\ColorScheme|string|null $colorScheme = null,
         Country|string|null $country = null,
         ?string $directURL = null,
         ?string $domain = null,

src/Services/WebRawService.php

@@ -18,9 +18,9 @@
 use ContextDev\Web\WebExtractParams\Pdf;
 use ContextDev\Web\WebExtractResponse;
 use ContextDev\Web\WebExtractStyleguideParams;
+use ContextDev\Web\WebExtractStyleguideParams\ColorScheme;
 use ContextDev\Web\WebExtractStyleguideResponse;
 use ContextDev\Web\WebScreenshotParams;
-use ContextDev\Web\WebScreenshotParams\ColorScheme;
 use ContextDev\Web\WebScreenshotParams\Country;
 use ContextDev\Web\WebScreenshotParams\FullScreenshot;
 use ContextDev\Web\WebScreenshotParams\HandleCookiePopup;
@@ -181,7 +181,11 @@ public function extractFonts(
      * Extract a comprehensive design system from a website including colors, typography, spacing, shadows, and UI components.
      *
      * @param array{
-     *   directURL?: string, domain?: string, maxAgeMs?: int, timeoutMs?: int
+     *   colorScheme?: ColorScheme|value-of<ColorScheme>,
+     *   directURL?: string,
+     *   domain?: string,
+     *   maxAgeMs?: int,
+     *   timeoutMs?: int,
      * }|WebExtractStyleguideParams $params
      * @param RequestOpts|null $requestOptions
      *
@@ -217,7 +221,7 @@ public function extractStyleguide(
      * Capture a screenshot of a website.
      *
      * @param array{
-     *   colorScheme?: ColorScheme|value-of<ColorScheme>,
+     *   colorScheme?: WebScreenshotParams\ColorScheme|value-of<WebScreenshotParams\ColorScheme>,
      *   country?: value-of<Country>,
      *   directURL?: string,
      *   domain?: string,

src/Services/WebService.php

@@ -13,8 +13,8 @@
 use ContextDev\Web\WebExtractFontsResponse;
 use ContextDev\Web\WebExtractParams\Pdf;
 use ContextDev\Web\WebExtractResponse;
+use ContextDev\Web\WebExtractStyleguideParams\ColorScheme;
 use ContextDev\Web\WebExtractStyleguideResponse;
-use ContextDev\Web\WebScreenshotParams\ColorScheme;
 use ContextDev\Web\WebScreenshotParams\Country;
 use ContextDev\Web\WebScreenshotParams\FullScreenshot;
 use ContextDev\Web\WebScreenshotParams\HandleCookiePopup;
@@ -190,6 +190,7 @@ public function extractFonts(
      *
      * Extract a comprehensive design system from a website including colors, typography, spacing, shadows, and UI components.
      *
+     * @param ColorScheme|value-of<ColorScheme> $colorScheme Optional browser color scheme to emulate for websites that respond to prefers-color-scheme. This value is part of the styleguide cache key.
      * @param string $directURL A specific URL to fetch the styleguide from directly, bypassing domain resolution (e.g., 'https://example.com/design-system'). When provided, the styleguide is extracted from this exact URL. You must provide either 'domain' or 'directUrl', but not both.
      * @param string $domain Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both.
      * @param int $maxAgeMs Maximum age in milliseconds for cached data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 year.
@@ -199,6 +200,7 @@ public function extractFonts(
      * @throws APIException
      */
     public function extractStyleguide(
+        ColorScheme|string|null $colorScheme = null,
         ?string $directURL = null,
         ?string $domain = null,
         int $maxAgeMs = 7776000000,
@@ -207,6 +209,7 @@ public function extractStyleguide(
     ): WebExtractStyleguideResponse {
         $params = Util::removeNulls(
             [
+                'colorScheme' => $colorScheme,
                 'directURL' => $directURL,
                 'domain' => $domain,
                 'maxAgeMs' => $maxAgeMs,
@@ -225,7 +228,7 @@ public function extractStyleguide(
      *
      * Capture a screenshot of a website.
      *
-     * @param ColorScheme|value-of<ColorScheme> $colorScheme Optional parameter to choose the site's visual theme in the screenshot. Use 'light' or 'dark' when the site offers both appearances.
+     * @param \ContextDev\Web\WebScreenshotParams\ColorScheme|value-of<\ContextDev\Web\WebScreenshotParams\ColorScheme> $colorScheme Optional parameter to choose the site's visual theme in the screenshot. Use 'light' or 'dark' when the site offers both appearances.
      * @param Country|value-of<Country> $country Two-letter ISO 3166-1 alpha-2 country code for the website request location. When provided, Context.dev fetches the target page from that country.
      * @param string $directURL A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https://example.com/pricing'). When provided, the screenshot is taken of this exact URL. You must provide either 'domain' or 'directUrl', but not both.
      * @param string $domain Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both.
@@ -242,7 +245,7 @@ public function extractStyleguide(
      * @throws APIException
      */
     public function screenshot(
-        ColorScheme|string|null $colorScheme = null,
+        \ContextDev\Web\WebScreenshotParams\ColorScheme|string|null $colorScheme = null,
         Country|string|null $country = null,
         ?string $directURL = null,
         ?string $domain = null,

src/Web/WebExtractStyleguideParams.php

@@ -8,13 +8,15 @@
 use ContextDev\Core\Concerns\SdkModel;
 use ContextDev\Core\Concerns\SdkParams;
 use ContextDev\Core\Contracts\BaseModel;
+use ContextDev\Web\WebExtractStyleguideParams\ColorScheme;
 
 /**
  * Extract a comprehensive design system from a website including colors, typography, spacing, shadows, and UI components.
  *
  * @see ContextDev\Services\WebService::extractStyleguide()
  *
  * @phpstan-type WebExtractStyleguideParamsShape = array{
+ *   colorScheme?: null|ColorScheme|value-of<ColorScheme>,
  *   directURL?: string|null,
  *   domain?: string|null,
  *   maxAgeMs?: int|null,
@@ -27,6 +29,14 @@ final class WebExtractStyleguideParams implements BaseModel
     use SdkModel;
     use SdkParams;
 
+    /**
+     * Optional browser color scheme to emulate for websites that respond to prefers-color-scheme. This value is part of the styleguide cache key.
+     *
+     * @var value-of<ColorScheme>|null $colorScheme
+     */
+    #[Optional(enum: ColorScheme::class)]
+    public ?string $colorScheme;
+
     /**
      * A specific URL to fetch the styleguide from directly, bypassing domain resolution (e.g., 'https://example.com/design-system'). When provided, the styleguide is extracted from this exact URL. You must provide either 'domain' or 'directUrl', but not both.
      */
@@ -60,15 +70,19 @@ public function __construct()
      * Construct an instance from the required parameters.
      *
      * You must use named parameters to construct any parameters with a default value.
+     *
+     * @param ColorScheme|value-of<ColorScheme>|null $colorScheme
      */
     public static function with(
+        ColorScheme|string|null $colorScheme = null,
         ?string $directURL = null,
         ?string $domain = null,
         ?int $maxAgeMs = null,
         ?int $timeoutMs = null,
     ): self {
         $self = new self;
 
+        null !== $colorScheme && $self['colorScheme'] = $colorScheme;
         null !== $directURL && $self['directURL'] = $directURL;
         null !== $domain && $self['domain'] = $domain;
         null !== $maxAgeMs && $self['maxAgeMs'] = $maxAgeMs;
@@ -77,6 +91,19 @@ public static function with(
         return $self;
     }
 
+    /**
+     * Optional browser color scheme to emulate for websites that respond to prefers-color-scheme. This value is part of the styleguide cache key.
+     *
+     * @param ColorScheme|value-of<ColorScheme> $colorScheme
+     */
+    public function withColorScheme(ColorScheme|string $colorScheme): self
+    {
+        $self = clone $this;
+        $self['colorScheme'] = $colorScheme;
+
+        return $self;
+    }
+
     /**
      * A specific URL to fetch the styleguide from directly, bypassing domain resolution (e.g., 'https://example.com/design-system'). When provided, the styleguide is extracted from this exact URL. You must provide either 'domain' or 'directUrl', but not both.
      */

src/Web/WebExtractStyleguideParams/ColorScheme.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ContextDev\Web\WebExtractStyleguideParams;
+
+/**
+ * Optional browser color scheme to emulate for websites that respond to prefers-color-scheme. This value is part of the styleguide cache key.
+ */
+enum ColorScheme: string
+{
+    case LIGHT = 'light';
+
+    case DARK = 'dark';
+}