context.dev 2.15.0 → 2.17.0

data/lib/context_dev/models/web_answers_response.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Web#answers
+    class WebAnswersResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute json_content
+      #   The answer, in the shape requested by json_format.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :json_content, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
+
+      # @!attribute sources
+      #   URLs that supplied search results or readable page content, in first-seen order.
+      #   Unreadable pages are excluded.
+      #
+      #   @return [Array<String>]
+      required :sources, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!attribute key_metadata
+      #   Credit usage, included whenever a valid API key is provided.
+      #
+      #   @return [ContextDev::Models::WebAnswersResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebAnswersResponse::KeyMetadata }
+
+      # @!attribute partial
+      #   True when the request deadline ended research and the answer uses the evidence
+      #   collected so far.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(json_content:, sources:, key_metadata: nil, partial: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebAnswersResponse} for more details.
+      #
+      #   @param json_content [Hash{Symbol=>Object}] The answer, in the shape requested by json_format.
+      #
+      #   @param sources [Array<String>] URLs that supplied search results or readable page content, in first-seen order.
+      #
+      #   @param key_metadata [ContextDev::Models::WebAnswersResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when the request deadline ended research and the answer uses the evidence c
+
+      # @see ContextDev::Models::WebAnswersResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   Credits used by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   Credits remaining for your organization.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, credits_remaining:)
+        #   Credit usage, included whenever a valid API key is provided.
+        #
+        #   @param credits_consumed [Integer] Credits used by this request.
+        #
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
+      end
+    end
+  end
+end

data/lib/context_dev/models/web_extract_competitors_params.rb

@@ -27,15 +27,15 @@ 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::WebExtractCompetitorsParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebExtractCompetitorsParams::TimeoutOpts }
 
-      # @!method initialize(domain:, num_competitors: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(domain:, num_competitors: nil, tags: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractCompetitorsParams} for more details.
       #
@@ -45,9 +45,54 @@ 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::WebExtractCompetitorsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @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::WebExtractCompetitorsParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebExtractCompetitorsParams::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::WebExtractCompetitorsParams::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::WebExtractCompetitorsParams::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_extract_competitors_response.rb

@@ -17,6 +17,13 @@ module ContextDev
       #   @return [String]
       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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute status
       #   Status of the response.
       #
@@ -35,16 +42,30 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata }
 
-      # @!method initialize(competitors:, domain:, status:, target:, key_metadata: nil)
+      # @!attribute partial
+      #   True when the timeout ended processing and this response contains only usable
+      #   results completed so far. Unfinished results are omitted.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(competitors:, domain:, request_id:, status:, target:, key_metadata: nil, partial: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebExtractCompetitorsResponse} for more details.
+      #
       #   @param competitors [Array<ContextDev::Models::WebExtractCompetitorsResponse::Competitor>] Direct competitors ordered by relevance and confidence.
       #
       #   @param domain [String] Normalized input domain.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param status [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status] Status of the response.
       #
       #   @param target [ContextDev::Models::WebExtractCompetitorsResponse::Target] Target company profile inferred from the landing page.
       #
       #   @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
 
       class Competitor < ContextDev::Internal::Type::BaseModel
         # @!attribute confidence

data/lib/context_dev/models/web_extract_fonts_params.rb

@@ -25,9 +25,9 @@ module ContextDev
 
       # @!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). Values below 1 day (86400000 ms)
-      #   are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-      #   year.
+      #   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.
       #
       #   @return [Integer, nil]
       optional :max_age_ms, Integer, nil?: true
@@ -39,15 +39,15 @@ 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::WebExtractFontsParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebExtractFontsParams::TimeoutOpts }
 
-      # @!method initialize(direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractFontsParams} for more details.
       #
@@ -59,9 +59,56 @@ 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::WebExtractFontsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @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-partial" requires milliseconds of at
+        #   least 15000.
+        #
+        #   @return [Symbol, ContextDev::Models::WebExtractFontsParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebExtractFontsParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebExtractFontsParams::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::WebExtractFontsParams::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::WebExtractFontsParams::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_extract_fonts_response.rb

@@ -31,12 +31,31 @@ module ContextDev
       required :fonts,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractFontsResponse::Font] }
 
+      # @!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 status
       #   Status of the response, e.g., 'ok'
       #
       #   @return [String]
       required :status, 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.
+      #
+      #   @return [Symbol, ContextDev::Models::WebExtractFontsResponse::FinalDomState, nil]
+      optional :final_dom_state,
+               enum: -> { ContextDev::Models::WebExtractFontsResponse::FinalDomState },
+               api_name: :finalDOMState
+
       # @!attribute font_links
       #   Font assets keyed by family name as it appears in the fonts array (non-generic
       #   names only). Clients match entries in fonts to pick a file URL from files.
@@ -53,7 +72,7 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractFontsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebExtractFontsResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, code:, domain:, fonts:, status:, font_links: nil, key_metadata: nil)
+      # @!method initialize(cache_metadata:, code:, domain:, fonts:, request_id:, status:, final_dom_state: nil, font_links: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractFontsResponse} for more details.
       #
@@ -65,8 +84,12 @@ module ContextDev
       #
       #   @param fonts [Array<ContextDev::Models::WebExtractFontsResponse::Font>] Array of font usage information
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
+      #   @param final_dom_state [Symbol, ContextDev::Models::WebExtractFontsResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
+      #
       #   @param font_links [Hash{Symbol=>ContextDev::Models::WebExtractFontsResponse::FontLink}] Font assets keyed by family name as it appears in the fonts array (non-generic n
       #
       #   @param key_metadata [ContextDev::Models::WebExtractFontsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
@@ -173,6 +196,23 @@ module ContextDev
         #   @param uses [Array<String>] Array of CSS selectors or element types where this font is used
       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::WebExtractFontsResponse#final_dom_state
+      module FinalDomState
+        extend ContextDev::Internal::Type::Enum
+
+        LOADED = :loaded
+        STILL_LOADING = :"still-loading"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       class FontLink < ContextDev::Internal::Type::BaseModel
         # @!attribute files
         #   Upright font files keyed by weight string (e.g. "400" for regular, "500",

data/lib/context_dev/models/web_extract_params.rb

@@ -110,13 +110,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, api_name: :timeoutMS
+      #   @return [ContextDev::Models::WebExtractParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebExtractParams::TimeoutOpts }, api_name: :timeoutOpts
 
       # @!attribute wait_for_ms
       #   Optional browser wait time in milliseconds after initial page load for each
@@ -125,7 +125,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, api_name: :waitForMs
 
-      # @!method initialize(schema:, url:, actions: nil, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, stop_after_ms: nil, tags: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
+      # @!method initialize(schema:, url:, actions: nil, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, stop_after_ms: nil, tags: nil, timeout_opts: nil, wait_for_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractParams} for more details.
       #
@@ -157,7 +157,7 @@ module ContextDev
       #
       #   @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 timeout_opts [ContextDev::Models::WebExtractParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load for each craw
       #
@@ -342,6 +342,51 @@ module ContextDev
         #
         #   @param start [Integer] First 1-based PDF page to parse.
       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 [Symbol, ContextDev::Models::WebExtractParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebExtractParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebExtractParams::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::WebExtractParams::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::WebExtractParams::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_extract_response.rb

@@ -23,6 +23,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractResponse::Metadata]
       required :metadata, -> { ContextDev::Models::WebExtractResponse::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 status
       #   Status of the response, e.g., 'ok'
       #
@@ -47,7 +54,14 @@ module ContextDev
       #   @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil)
+      # @!attribute partial
+      #   True when the timeout ended processing and this response contains only usable
+      #   results completed so far. Unfinished results are omitted.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(cache_metadata:, data:, metadata:, request_id:, status:, url:, urls_analyzed:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractResponse} for more details.
       #
@@ -57,6 +71,8 @@ module ContextDev
       #
       #   @param metadata [ContextDev::Models::WebExtractResponse::Metadata]
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param url [String] The starting URL that was analyzed
@@ -64,6 +80,8 @@ module ContextDev
       #   @param urls_analyzed [Array<String>] List of URLs whose Markdown was used for extraction
       #
       #   @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
 
       # @see ContextDev::Models::WebExtractResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel

data/lib/context_dev/models/web_extract_styleguide_params.rb

@@ -33,9 +33,9 @@ module ContextDev
 
       # @!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). Values below 1 day (86400000 ms)
-      #   are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-      #   year.
+      #   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.
       #
       #   @return [Integer, nil]
       optional :max_age_ms, Integer, nil?: true
@@ -47,15 +47,15 @@ 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::WebExtractStyleguideParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebExtractStyleguideParams::TimeoutOpts }
 
-      # @!method initialize(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebExtractStyleguideParams} for more details.
       #
@@ -69,7 +69,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::WebExtractStyleguideParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -84,6 +84,53 @@ module ContextDev
         # @!method self.values
         #   @return [Array<Symbol>]
       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::WebExtractStyleguideParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebExtractStyleguideParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   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.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::WebExtractStyleguideParams::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::WebExtractStyleguideParams::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