context.dev 2.4.0 → 2.5.0

data/lib/context_dev/models/web_screenshot_params.rb

@@ -15,8 +15,9 @@ module ContextDev
       optional :color_scheme, enum: -> { ContextDev::WebScreenshotParams::ColorScheme }
 
       # @!attribute 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.
+      #   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.
       #
       #   @return [Symbol, ContextDev::Models::WebScreenshotParams::Country, nil]
       optional :country, enum: -> { ContextDev::WebScreenshotParams::Country }
@@ -50,8 +51,8 @@ module ContextDev
       #   dismiss cookie banner before capture. If 'false' or not provided, captures the
       #   page without that step.
       #
-      #   @return [Symbol, ContextDev::Models::WebScreenshotParams::HandleCookiePopup, nil]
-      optional :handle_cookie_popup, enum: -> { ContextDev::WebScreenshotParams::HandleCookiePopup }
+      #   @return [Boolean, Symbol, ContextDev::Models::WebScreenshotParams::HandleCookiePopup, nil]
+      optional :handle_cookie_popup, union: -> { ContextDev::WebScreenshotParams::HandleCookiePopup }
 
       # @!attribute max_age_ms
       #   Return a cached screenshot if a prior screenshot for the same parameters exists
@@ -59,7 +60,7 @@ module ContextDev
       #   omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.
       #
       #   @return [Integer, nil]
-      optional :max_age_ms, Integer
+      optional :max_age_ms, Integer, nil?: true
 
       # @!attribute page
       #   Optional parameter to specify which page type to screenshot. If provided, the
@@ -80,7 +81,15 @@ module ContextDev
       #   precedence over fullScreenshot. Max: 100000.
       #
       #   @return [Integer, nil]
-      optional :scroll_offset, Integer
+      optional :scroll_offset, Integer, nil?: true
+
+      # @!attribute tags
+      #   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.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute timeout_ms
       #   Optional timeout in milliseconds for the request. If the request takes longer
@@ -102,15 +111,24 @@ module ContextDev
       #   omitted.
       #
       #   @return [Integer, nil]
-      optional :wait_for_ms, Integer
+      optional :wait_for_ms, Integer, nil?: true
+
+      # @!attribute zdr
+      #   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.
+      #
+      #   @return [Symbol, ContextDev::Models::WebScreenshotParams::Zdr, nil]
+      optional :zdr, enum: -> { ContextDev::WebScreenshotParams::Zdr }
 
-      # @!method initialize(color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {})
+      # @!method initialize(color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, tags: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebScreenshotParams} for more details.
       #
       #   @param color_scheme [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig
       #
-      #   @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe
+      #   @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev r
       #
       #   @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https
       #
@@ -118,19 +136,23 @@ module ContextDev
       #
       #   @param full_screenshot [Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc
       #
-      #   @param handle_cookie_popup [Symbol, ContextDev::Models::WebScreenshotParams::HandleCookiePopup] Optional parameter to control cookie/consent popup handling. If 'true', we dismi
+      #   @param handle_cookie_popup [Boolean, Symbol, ContextDev::Models::WebScreenshotParams::HandleCookiePopup] Optional parameter to control cookie/consent popup handling. If 'true', we dismi
       #
-      #   @param max_age_ms [Integer] Return a cached screenshot if a prior screenshot for the same parameters exists
+      #   @param max_age_ms [Integer, nil] Return a cached screenshot if a prior screenshot for the same parameters exists
       #
       #   @param page [Symbol, ContextDev::Models::WebScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy
       #
-      #   @param scroll_offset [Integer] Optional vertical scroll offset in pixels for capturing a long page in viewport-
+      #   @param scroll_offset [Integer, nil] Optional vertical scroll offset in pixels for capturing a long page in viewport-
+      #
+      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       #   @param viewport [ContextDev::Models::WebScreenshotParams::Viewport] Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
       #
-      #   @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load before taking
+      #   @param wait_for_ms [Integer, nil] Optional browser wait time in milliseconds after initial page load before taking
+      #
+      #   @param zdr [Symbol, ContextDev::Models::WebScreenshotParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -146,8 +168,9 @@ module ContextDev
         #   @return [Array<Symbol>]
       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
 
@@ -377,13 +400,27 @@ 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
+
+        variant ContextDev::Internal::Type::Boolean
+
+        variant const: -> { ContextDev::Models::WebScreenshotParams::HandleCookiePopup::TRUE }
+
+        variant const: -> { ContextDev::Models::WebScreenshotParams::HandleCookiePopup::FALSE }
+
+        # @!method self.variants
+        #   @return [Array(Boolean, Symbol)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(T::Boolean, ContextDev::WebScreenshotParams::HandleCookiePopup::TaggedSymbol) }
+        end
+
+        # @!group
 
         TRUE = :true
         FALSE = :false
 
-        # @!method self.values
-        #   @return [Array<Symbol>]
+        # @!endgroup
       end
 
       # Optional parameter to specify which page type to screenshot. If provided, the
@@ -427,6 +464,20 @@ module ContextDev
         #
         #   @param width [Integer] Viewport width in pixels.
       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
+
+        ENABLED = :enabled
+        DISABLED = :disabled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/context_dev/models/web_screenshot_response.rb

@@ -30,7 +30,8 @@ module ContextDev
       optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata }
 
       # @!attribute screenshot
-      #   Public URL of the uploaded screenshot image
+      #   Public image URL for standard requests, or an in-memory data URL when ZDR is
+      #   enabled.
       #
       #   @return [String, nil]
       optional :screenshot, String
@@ -67,7 +68,7 @@ module ContextDev
       #
       #   @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
       #
-      #   @param screenshot [String] Public URL of the uploaded screenshot image
+      #   @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR is ena
       #
       #   @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured
       #

data/lib/context_dev/models/web_search_params.rb

@@ -61,6 +61,12 @@ module ContextDev
       #   @return [Boolean, nil]
       optional :query_fanout, ContextDev::Internal::Type::Boolean, api_name: :queryFanout
 
+      # @!attribute tags
+      #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
       # @!attribute timeout_ms
       #   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
@@ -69,7 +75,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer, api_name: :timeoutMS
 
-      # @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebSearchParams} for more details.
       #
@@ -89,6 +95,8 @@ module ContextDev
       #
       #   @param query_fanout [Boolean] Expand the query into multiple parallel variants for broader recall.
       #
+      #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]

data/lib/context_dev/models/web_web_crawl_md_params.rb

@@ -115,6 +115,12 @@ module ContextDev
       #   @return [Integer, nil]
       optional :stop_after_ms, Integer, api_name: :stopAfterMs
 
+      # @!attribute tags
+      #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
       # @!attribute timeout_ms
       #   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
@@ -143,7 +149,16 @@ module ContextDev
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, api_name: :waitForMs
 
-      # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
+      # @!attribute zdr
+      #   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.
+      #
+      #   @return [Symbol, ContextDev::Models::WebWebCrawlMdParams::Zdr, nil]
+      optional :zdr, enum: -> { ContextDev::WebWebCrawlMdParams::Zdr }
+
+      # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, tags: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebCrawlMdParams} for more details.
       #
@@ -177,6 +192,8 @@ module ContextDev
       #
       #   @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. After each scrape, the crawler c
       #
+      #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       #   @param url_regex [String] Regex pattern. Only URLs matching this pattern will be followed and scraped.
@@ -185,6 +202,8 @@ module ContextDev
       #
       #   @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load for each craw
       #
+      #   @param zdr [Symbol, ContextDev::Models::WebWebCrawlMdParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
       # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
@@ -446,6 +465,20 @@ module ContextDev
         #
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
       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
+
+        ENABLED = :enabled
+        DISABLED = :disabled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end