context.dev 2.4.0 → 2.5.0

data/rbi/context_dev/models/web_extract_params.rbi

@@ -85,6 +85,15 @@ module ContextDev
       sig { params(pdf: ContextDev::WebExtractParams::Pdf::OrHash).void }
       attr_writer :pdf
 
+      # When true, waits briefly for CSS and transition animations to settle before
+      # extracting each crawled page. Defaults to false. This adds a bit of latency in
+      # exchange for more stable output on animated pages.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :settle_animations
+
+      sig { params(settle_animations: T::Boolean).void }
+      attr_writer :settle_animations
+
       # Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000
       # (110s). Default: 80000 (80s).
       sig { returns(T.nilable(Integer)) }
@@ -93,6 +102,13 @@ module ContextDev
       sig { params(stop_after_ms: Integer).void }
       attr_writer :stop_after_ms
 
+      # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
       # value is 300000ms (5 minutes).
@@ -122,7 +138,9 @@ module ContextDev
           max_depth: Integer,
           max_pages: Integer,
           pdf: ContextDev::WebExtractParams::Pdf::OrHash,
+          settle_animations: T::Boolean,
           stop_after_ms: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           wait_for_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
@@ -159,9 +177,15 @@ module ContextDev
         # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
         max_pages: nil,
         pdf: nil,
+        # When true, waits briefly for CSS and transition animations to settle before
+        # extracting each crawled page. Defaults to false. This adds a bit of latency in
+        # exchange for more stable output on animated pages.
+        settle_animations: nil,
         # Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000
         # (110s). Default: 80000 (80s).
         stop_after_ms: nil,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -186,7 +210,9 @@ module ContextDev
             max_depth: Integer,
             max_pages: Integer,
             pdf: ContextDev::WebExtractParams::Pdf,
+            settle_animations: T::Boolean,
             stop_after_ms: Integer,
+            tags: T::Array[String],
             timeout_ms: Integer,
             wait_for_ms: Integer,
             request_options: ContextDev::RequestOptions

data/rbi/context_dev/models/web_extract_styleguide_params.rbi

@@ -52,15 +52,21 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
-      # Maximum age in milliseconds for cached data before the API performs a hard
+      # Maximum age in milliseconds for cached brand 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.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :max_age_ms
+      attr_accessor :max_age_ms
 
-      sig { params(max_age_ms: Integer).void }
-      attr_writer :max_age_ms
+      # Optional comma-separated caller-defined tags for tracking this request. Tags are
+      # recorded on the request's usage log and can be used to filter usage on the
+      # dashboard usage page. Up to 20 tags, each 1-50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
 
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -77,7 +83,8 @@ module ContextDev
             ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol,
           direct_url: String,
           domain: String,
-          max_age_ms: Integer,
+          max_age_ms: T.nilable(Integer),
+          tags: T::Array[String],
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -95,11 +102,15 @@ module ContextDev
         # domain will be automatically normalized and validated. You must provide either
         # 'domain' or 'directUrl', but not both.
         domain: nil,
-        # Maximum age in milliseconds for cached data before the API performs a hard
+        # Maximum age in milliseconds for cached brand 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.
         max_age_ms: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -115,7 +126,8 @@ module ContextDev
               ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol,
             direct_url: String,
             domain: String,
-            max_age_ms: Integer,
+            max_age_ms: T.nilable(Integer),
+            tags: T::Array[String],
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions
           }

data/rbi/context_dev/models/web_screenshot_params.rbi

@@ -27,8 +27,9 @@ module ContextDev
       end
       attr_writer :color_scheme
 
-      # 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.
+      # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
+      # residential proxy exit location. Must be one of Context.dev's supported
+      # countries. When provided, Context.dev fetches the target page from that country.
       sig do
         returns(T.nilable(ContextDev::WebScreenshotParams::Country::OrSymbol))
       end
@@ -81,7 +82,10 @@ module ContextDev
       sig do
         returns(
           T.nilable(
-            ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol
+            T.any(
+              T::Boolean,
+              ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol
+            )
           )
         )
       end
@@ -90,7 +94,10 @@ module ContextDev
       sig do
         params(
           handle_cookie_popup:
-            ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol
+            T.any(
+              T::Boolean,
+              ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol
+            )
         ).void
       end
       attr_writer :handle_cookie_popup
@@ -99,10 +106,7 @@ module ContextDev
       # and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
       # omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :max_age_ms
-
-      sig { params(max_age_ms: Integer).void }
-      attr_writer :max_age_ms
+      attr_accessor :max_age_ms
 
       # Optional parameter to specify which page type to screenshot. If provided, the
       # system will scrape the domain's links and use heuristics to find the most
@@ -124,10 +128,16 @@ module ContextDev
       # top to bottom). The final slice may be shorter than the viewport height. Takes
       # precedence over fullScreenshot. Max: 100000.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :scroll_offset
+      attr_accessor :scroll_offset
+
+      # Optional comma-separated caller-defined tags for tracking this request. Tags are
+      # recorded on the request's usage log and can be used to filter usage on the
+      # dashboard usage page. Up to 20 tags, each 1-50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
 
-      sig { params(scroll_offset: Integer).void }
-      attr_writer :scroll_offset
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
 
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -151,10 +161,17 @@ module ContextDev
       # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
       # omitted.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :wait_for_ms
+      attr_accessor :wait_for_ms
 
-      sig { params(wait_for_ms: Integer).void }
-      attr_writer :wait_for_ms
+      # Set to enabled to bypass shared caches and omit request and response content
+      # from retained usage logs. Requires zero data retention to be enabled for your
+      # organization (contact support@context.dev), otherwise the request fails with
+      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      sig { returns(T.nilable(ContextDev::WebScreenshotParams::Zdr::OrSymbol)) }
+      attr_reader :zdr
+
+      sig { params(zdr: ContextDev::WebScreenshotParams::Zdr::OrSymbol).void }
+      attr_writer :zdr
 
       sig do
         params(
@@ -165,13 +182,18 @@ module ContextDev
           full_screenshot:
             ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol,
           handle_cookie_popup:
-            ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol,
-          max_age_ms: Integer,
+            T.any(
+              T::Boolean,
+              ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol
+            ),
+          max_age_ms: T.nilable(Integer),
           page: ContextDev::WebScreenshotParams::Page::OrSymbol,
-          scroll_offset: Integer,
+          scroll_offset: T.nilable(Integer),
+          tags: T::Array[String],
           timeout_ms: Integer,
           viewport: ContextDev::WebScreenshotParams::Viewport::OrHash,
-          wait_for_ms: Integer,
+          wait_for_ms: T.nilable(Integer),
+          zdr: ContextDev::WebScreenshotParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -179,8 +201,9 @@ module ContextDev
         # Optional parameter to choose the site's visual theme in the screenshot. Use
         # 'light' or 'dark' when the site offers both appearances.
         color_scheme: nil,
-        # 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.
+        # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
+        # residential proxy exit location. Must be one of Context.dev's supported
+        # countries. When provided, Context.dev fetches the target page from that country.
         country: nil,
         # A specific URL to screenshot directly, bypassing domain resolution (e.g.,
         # 'https://example.com/pricing'). When provided, the screenshot is taken of this
@@ -215,6 +238,10 @@ module ContextDev
         # top to bottom). The final slice may be shorter than the viewport height. Takes
         # precedence over fullScreenshot. Max: 100000.
         scroll_offset: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -225,6 +252,11 @@ module ContextDev
         # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
         # omitted.
         wait_for_ms: nil,
+        # Set to enabled to bypass shared caches and omit request and response content
+        # from retained usage logs. Requires zero data retention to be enabled for your
+        # organization (contact support@context.dev), otherwise the request fails with
+        # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+        zdr: nil,
         request_options: {}
       )
       end
@@ -240,13 +272,18 @@ module ContextDev
             full_screenshot:
               ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol,
             handle_cookie_popup:
-              ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol,
-            max_age_ms: Integer,
+              T.any(
+                T::Boolean,
+                ContextDev::WebScreenshotParams::HandleCookiePopup::OrSymbol
+              ),
+            max_age_ms: T.nilable(Integer),
             page: ContextDev::WebScreenshotParams::Page::OrSymbol,
-            scroll_offset: Integer,
+            scroll_offset: T.nilable(Integer),
+            tags: T::Array[String],
             timeout_ms: Integer,
             viewport: ContextDev::WebScreenshotParams::Viewport,
-            wait_for_ms: Integer,
+            wait_for_ms: T.nilable(Integer),
+            zdr: ContextDev::WebScreenshotParams::Zdr::OrSymbol,
             request_options: ContextDev::RequestOptions
           }
         )
@@ -285,8 +322,9 @@ module ContextDev
         end
       end
 
-      # 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.
+      # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
+      # residential proxy exit location. Must be one of Context.dev's supported
+      # countries. When provided, Context.dev fetches the target page from that country.
       module Country
         extend ContextDev::Internal::Type::Enum
 
@@ -548,7 +586,25 @@ module ContextDev
       # dismiss cookie banner before capture. If 'false' or not provided, captures the
       # page without that step.
       module HandleCookiePopup
-        extend ContextDev::Internal::Type::Enum
+        extend ContextDev::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              T::Boolean,
+              ContextDev::WebScreenshotParams::HandleCookiePopup::TaggedSymbol
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::WebScreenshotParams::HandleCookiePopup::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
 
         TaggedSymbol =
           T.type_alias do
@@ -566,16 +622,6 @@ module ContextDev
             :false,
             ContextDev::WebScreenshotParams::HandleCookiePopup::TaggedSymbol
           )
-
-        sig do
-          override.returns(
-            T::Array[
-              ContextDev::WebScreenshotParams::HandleCookiePopup::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
       end
 
       # Optional parameter to specify which page type to screenshot. If provided, the
@@ -654,6 +700,31 @@ module ContextDev
         def to_hash
         end
       end
+
+      # Set to enabled to bypass shared caches and omit request and response content
+      # from retained usage logs. Requires zero data retention to be enabled for your
+      # organization (contact support@context.dev), otherwise the request fails with
+      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      module Zdr
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ContextDev::WebScreenshotParams::Zdr) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENABLED =
+          T.let(:enabled, ContextDev::WebScreenshotParams::Zdr::TaggedSymbol)
+        DISABLED =
+          T.let(:disabled, ContextDev::WebScreenshotParams::Zdr::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebScreenshotParams::Zdr::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_screenshot_response.rbi

@@ -49,7 +49,8 @@ module ContextDev
       end
       attr_writer :key_metadata
 
-      # Public URL of the uploaded screenshot image
+      # Public image URL for standard requests, or an in-memory data URL when ZDR is
+      # enabled.
       sig { returns(T.nilable(String)) }
       attr_reader :screenshot
 
@@ -112,7 +113,8 @@ module ContextDev
         # Metadata about the API key used for the request. Included in every response
         # whenever a valid API key is provided, even when the response status is not 200.
         key_metadata: nil,
-        # Public URL of the uploaded screenshot image
+        # Public image URL for standard requests, or an in-memory data URL when ZDR is
+        # enabled.
         screenshot: nil,
         # Type of screenshot that was captured
         screenshot_type: nil,

data/rbi/context_dev/models/web_search_params.rbi

@@ -78,6 +78,13 @@ module ContextDev
       sig { params(query_fanout: T::Boolean).void }
       attr_writer :query_fanout
 
+      # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
       # value is 300000ms (5 minutes).
@@ -98,6 +105,7 @@ module ContextDev
             ContextDev::WebSearchParams::MarkdownOptions::OrHash,
           num_results: Integer,
           query_fanout: T::Boolean,
+          tags: T::Array[String],
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -123,6 +131,8 @@ module ContextDev
         num_results: nil,
         # Expand the query into multiple parallel variants for broader recall.
         query_fanout: nil,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -142,6 +152,7 @@ module ContextDev
             markdown_options: ContextDev::WebSearchParams::MarkdownOptions,
             num_results: Integer,
             query_fanout: T::Boolean,
+            tags: T::Array[String],
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions
           }

data/rbi/context_dev/models/web_web_crawl_md_params.rbi

@@ -135,6 +135,13 @@ module ContextDev
       sig { params(stop_after_ms: Integer).void }
       attr_writer :stop_after_ms
 
+      # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
       # value is 300000ms (5 minutes).
@@ -167,6 +174,16 @@ module ContextDev
       sig { params(wait_for_ms: Integer).void }
       attr_writer :wait_for_ms
 
+      # Set to enabled to bypass shared caches and omit request and response content
+      # from retained usage logs. Requires zero data retention to be enabled for your
+      # organization (contact support@context.dev), otherwise the request fails with
+      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      sig { returns(T.nilable(ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol)) }
+      attr_reader :zdr
+
+      sig { params(zdr: ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol).void }
+      attr_writer :zdr
+
       sig do
         params(
           url: String,
@@ -184,10 +201,12 @@ module ContextDev
           settle_animations: T::Boolean,
           shorten_base64_images: T::Boolean,
           stop_after_ms: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           url_regex: String,
           use_main_content_only: T::Boolean,
           wait_for_ms: Integer,
+          zdr: ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -240,6 +259,8 @@ module ContextDev
         # instead of continuing. Min: 10000 (10s). Max: 110000 (110s). Default: 80000
         # (80s).
         stop_after_ms: nil,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -252,6 +273,11 @@ module ContextDev
         # Optional browser wait time in milliseconds after initial page load for each
         # crawled page. Min: 0. Max: 30000 (30 seconds).
         wait_for_ms: nil,
+        # Set to enabled to bypass shared caches and omit request and response content
+        # from retained usage logs. Requires zero data retention to be enabled for your
+        # organization (contact support@context.dev), otherwise the request fails with
+        # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+        zdr: nil,
         request_options: {}
       )
       end
@@ -274,10 +300,12 @@ module ContextDev
             settle_animations: T::Boolean,
             shorten_base64_images: T::Boolean,
             stop_after_ms: Integer,
+            tags: T::Array[String],
             timeout_ms: Integer,
             url_regex: String,
             use_main_content_only: T::Boolean,
             wait_for_ms: Integer,
+            zdr: ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol,
             request_options: ContextDev::RequestOptions
           }
         )
@@ -591,6 +619,31 @@ module ContextDev
         def to_hash
         end
       end
+
+      # Set to enabled to bypass shared caches and omit request and response content
+      # from retained usage logs. Requires zero data retention to be enabled for your
+      # organization (contact support@context.dev), otherwise the request fails with
+      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      module Zdr
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ContextDev::WebWebCrawlMdParams::Zdr) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENABLED =
+          T.let(:enabled, ContextDev::WebWebCrawlMdParams::Zdr::TaggedSymbol)
+        DISABLED =
+          T.let(:disabled, ContextDev::WebWebCrawlMdParams::Zdr::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebWebCrawlMdParams::Zdr::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end