context.dev 2.15.0 → 2.17.0

data/lib/context_dev/models/web_web_scrape_html_response.rb

@@ -12,6 +12,18 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata }
 
+      # @!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.
+      #
+      #   @return [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState]
+      required :final_dom_state,
+               enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState },
+               api_name: :finalDOMState
+
       # @!attribute html
       #   The scraped content of the page. For normal pages this is the raw HTML. When the
       #   page is a sitemap or feed served behind an XSL stylesheet (which browsers render
@@ -26,6 +38,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata]
       required :metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::Metadata }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute success
       #   Indicates success
       #
@@ -68,16 +87,20 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, html:, metadata:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
+      # @!method initialize(cache_metadata:, final_dom_state:, html:, metadata:, request_id:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeHTMLResponse} for more details.
       #
       #   @param cache_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
+      #   @param final_dom_state [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
+      #
       #   @param html [String] The scraped content of the page. For normal pages this is the raw HTML. When the
       #
       #   @param metadata [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata] Metadata extracted from the scraped page HTML.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param success [Boolean, ContextDev::Models::WebWebScrapeHTMLResponse::Success] Indicates success
       #
       #   @param type [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::Type] Detected content type of the returned `html` field. Sitemaps and feeds are surfa
@@ -133,6 +156,23 @@ 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.
+      #
+      # @see ContextDev::Models::WebWebScrapeHTMLResponse#final_dom_state
+      module FinalDomState
+        extend ContextDev::Internal::Type::Enum
+
+        LOADED = :loaded
+        STILL_LOADING = :"still-loading"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see ContextDev::Models::WebWebScrapeHTMLResponse#metadata
       class Metadata < ContextDev::Internal::Type::BaseModel
         # @!attribute final_url

data/lib/context_dev/models/web_web_scrape_images_params.rb

@@ -63,22 +63,24 @@ module ContextDev
       #   @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
-      #   value is 300000ms (5 minutes).
+      # @!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.
       #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer
+      #   @return [ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebWebScrapeImagesParams::TimeoutOpts }
 
       # @!attribute wait_for_ms
       #   Optional browser wait time in milliseconds after initial page load before
-      #   collecting images. Min: 0. Max: 30000 (30 seconds).
+      #   collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
+      #   timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000 ms; a
+      #   shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
       #
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, nil?: true
 
-      # @!method initialize(url:, actions: nil, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, tags: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
+      # @!method initialize(url:, actions: nil, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, wait_for_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeImagesParams} for more details.
       #
@@ -96,7 +98,7 @@ module ContextDev
       #
       #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param wait_for_ms [Integer, nil] Optional browser wait time in milliseconds after initial page load before collec
       #
@@ -292,6 +294,53 @@ module ContextDev
         #
         #   @param resolution [Boolean] Measure image width and height when possible.
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        # @!attribute milliseconds
+        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @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 15000.
+        #
+        #   @return [Symbol, ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebWebScrapeImagesParams::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.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+        # 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 15000.
+        #
+        # @see ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/context_dev/models/web_web_scrape_images_response.rb

@@ -19,6 +19,13 @@ module ContextDev
       required :images,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image] }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute success
       #   Always true on success.
       #
@@ -39,13 +46,33 @@ module ContextDev
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied] },
                api_name: :actionsApplied
 
+      # @!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.
+      #
+      #   @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState, nil]
+      optional :final_dom_state,
+               enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState },
+               api_name: :finalDOMState
+
       # @!attribute key_metadata
       #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, images:, success:, url:, actions_applied: nil, key_metadata: nil)
+      # @!attribute partial
+      #   True when the deadline interrupted rendering or image enrichment. Partial
+      #   results are billed at the base request cost, without enrichment or actions
+      #   surcharges.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(cache_metadata:, images:, request_id:, success:, url:, actions_applied: nil, final_dom_state: nil, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeImagesResponse} for more details.
       #
@@ -53,13 +80,19 @@ module ContextDev
       #
       #   @param images [Array<ContextDev::Models::WebWebScrapeImagesResponse::Image>] Images found on the page.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success.
       #
       #   @param url [String] Page URL that was scraped.
       #
       #   @param actions_applied [Array<ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied>] One verified outcome per requested browser action, in request order.
       #
+      #   @param final_dom_state [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
+      #
       #   @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when the deadline interrupted rendering or image enrichment. Partial result
 
       # @see ContextDev::Models::WebWebScrapeImagesResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -333,6 +366,23 @@ 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.
+      #
+      # @see ContextDev::Models::WebWebScrapeImagesResponse#final_dom_state
+      module FinalDomState
+        extend ContextDev::Internal::Type::Enum
+
+        LOADED = :loaded
+        STILL_LOADING = :"still-loading"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see ContextDev::Models::WebWebScrapeImagesResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models/web_web_scrape_md_params.rb

@@ -117,13 +117,13 @@ module ContextDev
       #   @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
-      #   value is 300000ms (5 minutes).
+      # @!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.
       #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer
+      #   @return [ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebWebScrapeMdParams::TimeoutOpts }
 
       # @!attribute use_main_content_only
       #   Extract only the main content of the page, excluding headers, footers, sidebars,
@@ -134,7 +134,9 @@ module ContextDev
 
       # @!attribute wait_for_ms
       #   Optional browser wait time in milliseconds after initial page load before
-      #   converting the page to Markdown. Min: 0. Max: 30000 (30 seconds).
+      #   converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
+      #   with timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000
+      #   ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
       #
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, nil?: true
@@ -148,7 +150,7 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::WebWebScrapeMdParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebWebScrapeMdParams::Zdr }
 
-      # @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_html: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, tags: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_html: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, tags: nil, timeout_opts: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeMdParams} for more details.
       #
@@ -182,7 +184,7 @@ module ContextDev
       #
       #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars,
       #
@@ -601,6 +603,53 @@ module ContextDev
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
       end
 
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        # @!attribute milliseconds
+        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @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 15000.
+        #
+        #   @return [Symbol, ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebWebScrapeMdParams::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.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+        # 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 15000.
+        #
+        # @see ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        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

data/lib/context_dev/models/web_web_scrape_md_response.rb

@@ -20,6 +20,18 @@ module ContextDev
       #   @return [Integer]
       required :content_length, Integer, api_name: :contentLength
 
+      # @!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.
+      #
+      #   @return [Symbol, ContextDev::Models::WebWebScrapeMdResponse::FinalDomState]
+      required :final_dom_state,
+               enum: -> { ContextDev::Models::WebWebScrapeMdResponse::FinalDomState },
+               api_name: :finalDOMState
+
       # @!attribute markdown
       #   Page content converted to GitHub Flavored Markdown
       #
@@ -32,6 +44,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeMdResponse::Metadata]
       required :metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::Metadata }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute success
       #   Indicates success
       #
@@ -73,7 +92,7 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, content_length:, markdown:, metadata:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil)
+      # @!method initialize(cache_metadata:, content_length:, final_dom_state:, markdown:, metadata:, request_id:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeMdResponse} for more details.
       #
@@ -81,10 +100,14 @@ module ContextDev
       #
       #   @param content_length [Integer] UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result an
       #
+      #   @param final_dom_state [Symbol, ContextDev::Models::WebWebScrapeMdResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
+      #
       #   @param markdown [String] Page content converted to GitHub Flavored Markdown
       #
       #   @param metadata [ContextDev::Models::WebWebScrapeMdResponse::Metadata] Metadata extracted from the scraped page HTML.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param success [Boolean, ContextDev::Models::WebWebScrapeMdResponse::Success] Indicates success
       #
       #   @param url [String] The URL that was scraped
@@ -140,6 +163,23 @@ 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.
+      #
+      # @see ContextDev::Models::WebWebScrapeMdResponse#final_dom_state
+      module FinalDomState
+        extend ContextDev::Internal::Type::Enum
+
+        LOADED = :loaded
+        STILL_LOADING = :"still-loading"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see ContextDev::Models::WebWebScrapeMdResponse#metadata
       class Metadata < ContextDev::Internal::Type::BaseModel
         # @!attribute final_url

data/lib/context_dev/models/web_web_scrape_sitemap_params.rb

@@ -57,13 +57,13 @@ module ContextDev
       #   @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
-      #   value is 300000ms (5 minutes).
+      # @!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.
       #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer
+      #   @return [ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebWebScrapeSitemapParams::TimeoutOpts }
 
       # @!attribute url_regex
       #   Optional RE2-compatible regex pattern. Only URLs matching this pattern are
@@ -81,7 +81,7 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebWebScrapeSitemapParams::Zdr }
 
-      # @!method initialize(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
+      # @!method initialize(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_opts: nil, url_regex: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
       #
@@ -99,7 +99,7 @@ module ContextDev
       #
       #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur
       #
@@ -107,6 +107,51 @@ module ContextDev
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        # @!attribute milliseconds
+        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @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 [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebWebScrapeSitemapParams::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.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+        # 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.
+        #
+        # @see ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        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

data/lib/context_dev/models/web_web_scrape_sitemap_response.rb

@@ -16,6 +16,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeSitemapResponse::Meta]
       required :meta, -> { ContextDev::Models::WebWebScrapeSitemapResponse::Meta }
 
+      # @!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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute success
       #   Indicates success
       #
@@ -35,7 +42,15 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata }
 
-      # @!method initialize(domain:, meta:, success:, urls:, key_metadata: nil)
+      # @!attribute partial
+      #   True when timeoutOpts.behavior=return-partial returned the usable results
+      #   collected before the deadline. Partial collections are not cached as complete
+      #   results.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(domain:, meta:, request_id:, success:, urls:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeSitemapResponse} for more details.
       #
@@ -43,11 +58,15 @@ module ContextDev
       #
       #   @param meta [ContextDev::Models::WebWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param success [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success] Indicates success
       #
       #   @param urls [Array<String>] Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set th
       #
       #   @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when timeoutOpts.behavior=return-partial returned the usable results collec
 
       # @see ContextDev::Models::WebWebScrapeSitemapResponse#meta
       class Meta < ContextDev::Internal::Type::BaseModel

data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb

@@ -23,19 +23,31 @@ module ContextDev
         #   @return [String, nil]
         required :next_cursor, String, nil?: true
 
+        # @!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.
+        #
+        #   @return [String]
+        required :request_id, String
+
         # @!attribute key_metadata
         #   Credit usage, included whenever a valid API key is provided.
         #
         #   @return [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata, nil]
         optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata }
 
-        # @!method initialize(data:, has_more:, next_cursor:, key_metadata: nil)
+        # @!method initialize(data:, has_more:, next_cursor:, request_id:, key_metadata: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::Webhooks::DeliveryListAttemptsResponse} for more details.
+        #
         #   @param data [Array<ContextDev::Models::Webhooks::Attempt>] Delivery attempts.
         #
         #   @param has_more [Boolean] Whether more attempts are available.
         #
         #   @param next_cursor [String, nil] Next page cursor, or null on the last page.
         #
+        #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #
         #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
         # @see ContextDev::Models::Webhooks::DeliveryListAttemptsResponse#key_metadata

data/lib/context_dev/models/webhooks/delivery_list_response.rb

@@ -23,19 +23,31 @@ module ContextDev
         #   @return [String, nil]
         required :next_cursor, String, nil?: true
 
+        # @!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.
+        #
+        #   @return [String]
+        required :request_id, String
+
         # @!attribute key_metadata
         #   Credit usage, included whenever a valid API key is provided.
         #
         #   @return [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata, nil]
         optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata }
 
-        # @!method initialize(data:, has_more:, next_cursor:, key_metadata: nil)
+        # @!method initialize(data:, has_more:, next_cursor:, request_id:, key_metadata: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::Webhooks::DeliveryListResponse} for more details.
+        #
         #   @param data [Array<ContextDev::Models::Webhooks::DeliverySummary>] Webhook deliveries.
         #
         #   @param has_more [Boolean] Whether more deliveries are available.
         #
         #   @param next_cursor [String, nil] Next page cursor, or null on the last page.
         #
+        #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #
         #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
         # @see ContextDev::Models::Webhooks::DeliveryListResponse#key_metadata