context.dev 2.21.0 → 2.22.0

data/lib/context_dev/models/web_extract_styleguide_params.rb

@@ -15,10 +15,7 @@ module ContextDev
       optional :color_scheme, enum: -> { ContextDev::WebExtractStyleguideParams::ColorScheme }
 
       # @!attribute direct_url
-      #   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.
+      #   Exact URL to inspect. Provide either `domain` or `directUrl`, not both.
       #
       #   @return [String, nil]
       optional :direct_url, String
@@ -32,35 +29,27 @@ module ContextDev
       optional :domain, String
 
       # @!attribute max_age_ms
-      #   Maximum age in milliseconds for cached brand data before the API performs a hard
-      #   refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
-      #   refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
-      #   are clamped to 1 year.
+      #   Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
+      #   year. `0` refreshes.
       #
       #   @return [Integer, nil]
       optional :max_age_ms, Integer, nil?: true
 
       # @!attribute tags
-      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-      #   characters.
+      #   Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute timeout_opts
-      #   Optional request deadline and behavior on timeout. For GET requests, use
-      #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      #   timeoutOpts object.
+      #   Request deadline and what to return when it passes.
       #
       #   @return [ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts, nil]
       optional :timeout_opts, -> { ContextDev::WebExtractStyleguideParams::TimeoutOpts }
 
       # @!attribute zdr
-      #   Set to enabled to bypass shared caches and omit request and response content
-      #   from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      #   omitted. 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.
+      #   `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      #   your organization has ZDR.
       #
       #   @return [Symbol, ContextDev::Models::WebExtractStyleguideParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebExtractStyleguideParams::Zdr }
@@ -71,17 +60,17 @@ module ContextDev
       #
       #   @param color_scheme [Symbol, ContextDev::Models::WebExtractStyleguideParams::ColorScheme] Optional browser color scheme to emulate for websites that respond to prefers-co
       #
-      #   @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
+      #   @param direct_url [String] Exact URL to inspect. Provide either `domain` or `directUrl`, not both.
       #
       #   @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       #
-      #   @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
+      #   @param max_age_ms [Integer, nil] Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1 yea
       #
-      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      #   @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
-      #   @param timeout_opts [ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #   @param timeout_opts [ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
-      #   @param zdr [Symbol, ContextDev::Models::WebExtractStyleguideParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #   @param zdr [Symbol, ContextDev::Models::WebExtractStyleguideParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -99,17 +88,14 @@ module ContextDev
 
       class TimeoutOpts < ContextDev::Internal::Type::BaseModel
         # @!attribute milliseconds
-        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   Deadline in milliseconds.
         #
         #   @return [Integer]
         required :milliseconds, Integer
 
         # @!attribute behavior
-        #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        #   credits. "return-partial" returns usable results collected so far; if none are
-        #   available, the request still fails without charging credits. Partial results are
-        #   not cached as complete results. "return-partial" requires milliseconds of at
-        #   least 5000.
+        #   "fail" returns 408 at the deadline. "return-partial" returns available results;
+        #   inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
         #
         #   @return [Symbol, ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts::Behavior, nil]
         optional :behavior, enum: -> { ContextDev::WebExtractStyleguideParams::TimeoutOpts::Behavior }
@@ -118,19 +104,14 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts} for more details.
         #
-        #   Optional request deadline and behavior on timeout. For GET requests, use
-        #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        #   timeoutOpts object.
+        #   Request deadline and what to return when it passes.
         #
-        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   @param milliseconds [Integer] Deadline in milliseconds.
         #
-        #   @param behavior [Symbol, ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+        #   @param behavior [Symbol, ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results. "return-partial" requires milliseconds of at
-        # least 5000.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
         #
         # @see ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts#behavior
         module Behavior
@@ -144,11 +125,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. 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.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/lib/context_dev/models/web_extract_styleguide_response.rb

@@ -5,16 +5,14 @@ module ContextDev
     # @see ContextDev::Resources::Web#extract_styleguide
     class WebExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel
       # @!attribute cache_metadata
-      #   Cache outcome for this response. Composite responses are hits only when every
-      #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-      #   oldest contributing hit.
+      #   Whether this response came from cache.
       #
       #   @return [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata }
 
       # @!attribute request_id
-      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #   it when contacting support about a failed request.
+      #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      #   support.
       #
       #   @return [String]
       required :request_id, String
@@ -32,11 +30,8 @@ module ContextDev
       optional :domain, String
 
       # @!attribute final_dom_state
-      #   How complete the returned content is. `loaded` means the page finished the waits
-      #   the request asked for. `still-loading` only occurs with
-      #   timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-      #   reached first, so the content reflects the DOM at that moment and late-rendering
-      #   parts may be missing. Partial results are billed at the base request cost.
+      #   `loaded`, or `still-loading` when capture ended before the page finished
+      #   loading.
       #
       #   @return [Symbol, ContextDev::Models::WebExtractStyleguideResponse::FinalDomState, nil]
       optional :final_dom_state,
@@ -44,13 +39,13 @@ module ContextDev
                api_name: :finalDOMState
 
       # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
+      #   Credits this request used and your remaining balance.
       #
       #   @return [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata }
 
       # @!attribute status
-      #   Status of the response, e.g., 'ok'
+      #   Always `ok` on success.
       #
       #   @return [String, nil]
       optional :status, String
@@ -65,19 +60,19 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractStyleguideResponse} for more details.
       #
-      #   @param cache_metadata [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+      #   @param cache_metadata [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata] Whether this response came from cache.
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
       #
       #   @param code [Integer] HTTP status code
       #
       #   @param domain [String] The normalized domain that was processed
       #
-      #   @param final_dom_state [Symbol, ContextDev::Models::WebExtractStyleguideResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
+      #   @param final_dom_state [Symbol, ContextDev::Models::WebExtractStyleguideResponse::FinalDomState] `loaded`, or `still-loading` when capture ended before the page finished loading
       #
-      #   @param key_metadata [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata] Credits this request used and your remaining balance.
       #
-      #   @param status [String] Status of the response, e.g., 'ok'
+      #   @param status [String] Always `ok` on success.
       #
       #   @param styleguide [ContextDev::Models::WebExtractStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website
 
@@ -101,9 +96,7 @@ module ContextDev
         #   {ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata} for more
         #   details.
         #
-        #   Cache outcome for this response. Composite responses are hits only when every
-        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-        #   oldest contributing hit.
+        #   Whether this response came from cache.
         #
         #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
         #
@@ -125,11 +118,8 @@ module ContextDev
         end
       end
 
-      # How complete the returned content is. `loaded` means the page finished the waits
-      # the request asked for. `still-loading` only occurs with
-      # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-      # reached first, so the content reflects the DOM at that moment and late-rendering
-      # parts may be missing. Partial results are billed at the base request cost.
+      # `loaded`, or `still-loading` when capture ended before the page finished
+      # loading.
       #
       # @see ContextDev::Models::WebExtractStyleguideResponse#final_dom_state
       module FinalDomState
@@ -145,7 +135,7 @@ module ContextDev
       # @see ContextDev::Models::WebExtractStyleguideResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   Credits used by this request.
+        #   Credits charged for this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
@@ -157,9 +147,9 @@ module ContextDev
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
-        #   @param credits_consumed [Integer] Credits used by this request.
+        #   @param credits_consumed [Integer] Credits charged for this request.
         #
         #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
@@ -375,7 +365,7 @@ module ContextDev
               required :min_height, String, api_name: :minHeight
 
               # @!attribute min_width
-              #   Sampled minimum width of the button box (typically px)
+              #   Minimum width (usually px).
               #
               #   @return [String]
               required :min_width, String, api_name: :minWidth
@@ -435,7 +425,7 @@ module ContextDev
               #
               #   @param min_height [String] Sampled minimum height of the button box (typically px)
               #
-              #   @param min_width [String] Sampled minimum width of the button box (typically px)
+              #   @param min_width [String] Minimum width (usually px).
               #
               #   @param padding [String]
               #
@@ -511,7 +501,7 @@ module ContextDev
               required :min_height, String, api_name: :minHeight
 
               # @!attribute min_width
-              #   Sampled minimum width of the button box (typically px)
+              #   Minimum width (usually px).
               #
               #   @return [String]
               required :min_width, String, api_name: :minWidth
@@ -571,7 +561,7 @@ module ContextDev
               #
               #   @param min_height [String] Sampled minimum height of the button box (typically px)
               #
-              #   @param min_width [String] Sampled minimum width of the button box (typically px)
+              #   @param min_width [String] Minimum width (usually px).
               #
               #   @param padding [String]
               #
@@ -647,7 +637,7 @@ module ContextDev
               required :min_height, String, api_name: :minHeight
 
               # @!attribute min_width
-              #   Sampled minimum width of the button box (typically px)
+              #   Minimum width (usually px).
               #
               #   @return [String]
               required :min_width, String, api_name: :minWidth
@@ -707,7 +697,7 @@ module ContextDev
               #
               #   @param min_height [String] Sampled minimum height of the button box (typically px)
               #
-              #   @param min_width [String] Sampled minimum width of the button box (typically px)
+              #   @param min_width [String] Minimum width (usually px).
               #
               #   @param padding [String]
               #
@@ -1004,7 +994,7 @@ module ContextDev
               required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
 
               # @!attribute font_family
-              #   Primary face (first family in the computed stack)
+              #   First font in the stack.
               #
               #   @return [String]
               required :font_family, String, api_name: :fontFamily
@@ -1032,7 +1022,7 @@ module ContextDev
               # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
               #   @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
               #
-              #   @param font_family [String] Primary face (first family in the computed stack)
+              #   @param font_family [String] First font in the stack.
               #
               #   @param font_size [String]
               #
@@ -1052,7 +1042,7 @@ module ContextDev
               required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
 
               # @!attribute font_family
-              #   Primary face (first family in the computed stack)
+              #   First font in the stack.
               #
               #   @return [String]
               required :font_family, String, api_name: :fontFamily
@@ -1080,7 +1070,7 @@ module ContextDev
               # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
               #   @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
               #
-              #   @param font_family [String] Primary face (first family in the computed stack)
+              #   @param font_family [String] First font in the stack.
               #
               #   @param font_size [String]
               #
@@ -1100,7 +1090,7 @@ module ContextDev
               required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
 
               # @!attribute font_family
-              #   Primary face (first family in the computed stack)
+              #   First font in the stack.
               #
               #   @return [String]
               required :font_family, String, api_name: :fontFamily
@@ -1128,7 +1118,7 @@ module ContextDev
               # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
               #   @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
               #
-              #   @param font_family [String] Primary face (first family in the computed stack)
+              #   @param font_family [String] First font in the stack.
               #
               #   @param font_size [String]
               #
@@ -1148,7 +1138,7 @@ module ContextDev
               required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
 
               # @!attribute font_family
-              #   Primary face (first family in the computed stack)
+              #   First font in the stack.
               #
               #   @return [String]
               required :font_family, String, api_name: :fontFamily
@@ -1176,7 +1166,7 @@ module ContextDev
               # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
               #   @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
               #
-              #   @param font_family [String] Primary face (first family in the computed stack)
+              #   @param font_family [String] First font in the stack.
               #
               #   @param font_size [String]
               #
@@ -1197,7 +1187,7 @@ module ContextDev
             required :font_fallbacks, ContextDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
 
             # @!attribute font_family
-            #   Primary face (first family in the computed stack)
+            #   First font in the stack.
             #
             #   @return [String]
             required :font_family, String, api_name: :fontFamily
@@ -1225,7 +1215,7 @@ module ContextDev
             # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
             #   @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
             #
-            #   @param font_family [String] Primary face (first family in the computed stack)
+            #   @param font_family [String] First font in the stack.
             #
             #   @param font_size [String]
             #

data/lib/context_dev/models/web_map_urls_params.rb

@@ -8,59 +8,50 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute domain
-      #   Domain to build a sitemap for
+      #   Domain to map, e.g. `stripe.com`.
       #
       #   @return [String]
       required :domain, String
 
       # @!attribute headers
-      #   Optional outbound HTTP headers forwarded only to the target URL, sent as
-      #   deep-object query params such as headers[X-Custom]=value. When provided, caching
-      #   is bypassed: the result is neither read from nor written to cache.
+      #   HTTP headers for the target origin. Non-empty headers bypass caching.
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :headers, ContextDev::Internal::Type::HashOf[String]
 
       # @!attribute include_subdomains
-      #   When true, discover and include public pages and sitemaps on subdomains of the
-      #   requested domain. Defaults to false.
+      #   Include URLs on subdomains.
       #
       #   @return [Boolean, nil]
       optional :include_subdomains, ContextDev::Internal::Type::Boolean
 
       # @!attribute max_links
-      #   Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
-      #   Minimum is 1, maximum is 100,000.
+      #   Maximum number of URLs to return.
       #
       #   @return [Integer, nil]
       optional :max_links, Integer
 
       # @!attribute search
-      #   Optional search phrase. When provided, the crawled sitemap is filtered to the
-      #   pages whose URLs are about that phrase, most relevant first, and the request
-      #   costs 2 credits instead of 1.
+      #   Filter URLs by a topic or phrase, most relevant first.
       #
       #   @return [String, nil]
       optional :search, String
 
       # @!attribute sitemap_url
-      #   Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
-      #   instead of discovering the domain's sitemaps.
+      #   Fetch this sitemap instead of discovering sitemaps. Must belong to the domain or
+      #   a subdomain.
       #
       #   @return [String, nil]
       optional :sitemap_url, String
 
       # @!attribute tags
-      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-      #   characters.
+      #   Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute timeout_opts
-      #   Optional request deadline and behavior on timeout. For GET requests, use
-      #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      #   timeoutOpts object.
+      #   Request deadline and what to return when it passes.
       #
       #   @return [ContextDev::Models::WebMapURLsParams::TimeoutOpts, nil]
       optional :timeout_opts, -> { ContextDev::WebMapURLsParams::TimeoutOpts }
@@ -73,11 +64,8 @@ module ContextDev
       optional :url_regex, String
 
       # @!attribute zdr
-      #   Set to enabled to bypass shared caches and omit request and response content
-      #   from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      #   omitted. 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.
+      #   `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      #   your organization has ZDR.
       #
       #   @return [Symbol, ContextDev::Models::WebMapURLsParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebMapURLsParams::Zdr }
@@ -86,40 +74,38 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebMapURLsParams} for more details.
       #
-      #   @param domain [String] Domain to build a sitemap for
+      #   @param domain [String] Domain to map, e.g. `stripe.com`.
       #
-      #   @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
+      #   @param headers [Hash{Symbol=>String}] HTTP headers for the target origin. Non-empty headers bypass caching.
       #
-      #   @param include_subdomains [Boolean] When true, discover and include public pages and sitemaps on subdomains of the r
+      #   @param include_subdomains [Boolean] Include URLs on subdomains.
       #
-      #   @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi
+      #   @param max_links [Integer] Maximum number of URLs to return.
       #
-      #   @param search [String] Optional search phrase. When provided, the crawled sitemap is filtered to the pa
+      #   @param search [String] Filter URLs by a topic or phrase, most relevant first.
       #
-      #   @param sitemap_url [String] Optional explicit sitemap URL. When provided, exactly this sitemap is crawled in
+      #   @param sitemap_url [String] Fetch this sitemap instead of discovering sitemaps. Must belong to the domain or
       #
-      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      #   @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
-      #   @param timeout_opts [ContextDev::Models::WebMapURLsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #   @param timeout_opts [ContextDev::Models::WebMapURLsParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
       #   @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur
       #
-      #   @param zdr [Symbol, ContextDev::Models::WebMapURLsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #   @param zdr [Symbol, ContextDev::Models::WebMapURLsParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
       class TimeoutOpts < ContextDev::Internal::Type::BaseModel
         # @!attribute milliseconds
-        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   Deadline in milliseconds.
         #
         #   @return [Integer]
         required :milliseconds, Integer
 
         # @!attribute behavior
-        #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        #   credits. "return-partial" returns usable results collected so far; if none are
-        #   available, the request still fails without charging credits. Partial results are
-        #   not cached as complete results.
+        #   "fail" returns 408 at the deadline. "return-partial" returns available results;
+        #   inspect the response’s partial flag.
         #
         #   @return [Symbol, ContextDev::Models::WebMapURLsParams::TimeoutOpts::Behavior, nil]
         optional :behavior, enum: -> { ContextDev::WebMapURLsParams::TimeoutOpts::Behavior }
@@ -128,18 +114,14 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::WebMapURLsParams::TimeoutOpts} for more details.
         #
-        #   Optional request deadline and behavior on timeout. For GET requests, use
-        #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        #   timeoutOpts object.
+        #   Request deadline and what to return when it passes.
         #
-        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   @param milliseconds [Integer] Deadline in milliseconds.
         #
-        #   @param behavior [Symbol, ContextDev::Models::WebMapURLsParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+        #   @param behavior [Symbol, ContextDev::Models::WebMapURLsParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag.
         #
         # @see ContextDev::Models::WebMapURLsParams::TimeoutOpts#behavior
         module Behavior
@@ -153,11 +135,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. 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.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/lib/context_dev/models/web_map_urls_response.rb

@@ -10,8 +10,8 @@ module ContextDev
       required :domain, String
 
       # @!attribute request_id
-      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #   it when contacting support about a failed request.
+      #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      #   support.
       #
       #   @return [String]
       required :request_id, String
@@ -27,7 +27,7 @@ module ContextDev
       required :urls, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebMapURLsResponse::URL] }
 
       # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
+      #   Credits this request used and your remaining balance.
       #
       #   @return [ContextDev::Models::WebMapURLsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebMapURLsResponse::KeyMetadata }
@@ -43,13 +43,13 @@ module ContextDev
       #
       #   @param domain [String]
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
       #
       #   @param success [Boolean, ContextDev::Models::WebMapURLsResponse::Success]
       #
       #   @param urls [Array<ContextDev::Models::WebMapURLsResponse::URL>]
       #
-      #   @param key_metadata [ContextDev::Models::WebMapURLsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::WebMapURLsResponse::KeyMetadata] Credits this request used and your remaining balance.
       #
       #   @param partial [Boolean]
 
@@ -100,7 +100,7 @@ module ContextDev
       # @see ContextDev::Models::WebMapURLsResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   Credits used by this request.
+        #   Credits charged for this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
@@ -112,9 +112,9 @@ module ContextDev
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
-        #   @param credits_consumed [Integer] Credits used by this request.
+        #   @param credits_consumed [Integer] Credits charged for this request.
         #
         #   @param credits_remaining [Integer] Credits remaining for your organization.
       end