context.dev 2.3.0 → 2.5.0

data/lib/context_dev/models/web_web_scrape_html_params.rb

@@ -13,9 +13,20 @@ module ContextDev
       #   @return [String]
       required :url, String
 
+      # @!attribute actions
+      #   Optional browser actions executed in array order after the page loads and before
+      #   content is captured. Requires a paid plan. Send a JSON array in the query
+      #   parameter. Maximum: 5 actions.
+      #
+      #   @return [Array<ContextDev::Models::WebWebScrapeHTMLParams::Action::Wait, ContextDev::Models::WebWebScrapeHTMLParams::Action::Perform>, nil]
+      optional :actions,
+               -> { ContextDev::Internal::Type::ArrayOf[union: ContextDev::WebWebScrapeHTMLParams::Action] },
+               nil?: true
+
       # @!attribute country
-      #   Two-letter ISO 3166-1 alpha-2 country code for the website request location.
-      #   When provided, Context.dev fetches the target page from that country.
+      #   Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
+      #   residential proxy exit location. Must be one of Context.dev's supported
+      #   countries. When provided, Context.dev fetches the target page from that country.
       #
       #   @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country, nil]
       optional :country, enum: -> { ContextDev::WebWebScrapeHTMLParams::Country }
@@ -26,7 +37,7 @@ module ContextDev
       #   "nav", "footer", ".ad-banner", "[aria-hidden=true]".
       #
       #   @return [Array<String>, nil]
-      optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
+      optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute headers
       #   Optional outbound HTTP headers forwarded only to the target URL, sent as
@@ -39,8 +50,8 @@ module ContextDev
       # @!attribute include_frames
       #   When true, iframes are rendered inline into the returned HTML.
       #
-      #   @return [Boolean, nil]
-      optional :include_frames, ContextDev::Internal::Type::Boolean
+      #   @return [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::IncludeFrames, nil]
+      optional :include_frames, union: -> { ContextDev::WebWebScrapeHTMLParams::IncludeFrames }
 
       # @!attribute include_selectors
       #   CSS selectors. When provided, only matching subtrees (and their descendants) are
@@ -48,7 +59,7 @@ module ContextDev
       #   Examples: "article.main", "#content", "[role=main]".
       #
       #   @return [Array<String>, nil]
-      optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
+      optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute max_age_ms
       #   Return a cached result if a prior scrape for the same parameters exists and is
@@ -56,7 +67,7 @@ module ContextDev
       #   omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
       #
       #   @return [Integer, nil]
-      optional :max_age_ms, Integer
+      optional :max_age_ms, Integer, nil?: true
 
       # @!attribute pdf
       #   PDF parsing controls. Use start/end to limit text extraction and embedded-image
@@ -70,8 +81,16 @@ module ContextDev
       #   extracting HTML. Defaults to false. This adds a bit of latency in exchange for
       #   more stable output on animated pages.
       #
-      #   @return [Boolean, nil]
-      optional :settle_animations, ContextDev::Internal::Type::Boolean
+      #   @return [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::SettleAnimations, nil]
+      optional :settle_animations, union: -> { ContextDev::WebWebScrapeHTMLParams::SettleAnimations }
+
+      # @!attribute tags
+      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   recorded on the request's usage log and can be used to filter usage on the
+      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute timeout_ms
       #   Optional timeout in milliseconds for the request. If the request takes longer
@@ -85,48 +104,117 @@ module ContextDev
       #   When true, return only the page's main content in the HTML response, excluding
       #   headers, footers, sidebars, and navigation when detectable.
       #
-      #   @return [Boolean, nil]
-      optional :use_main_content_only, ContextDev::Internal::Type::Boolean
+      #   @return [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::UseMainContentOnly, nil]
+      optional :use_main_content_only, union: -> { ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly }
 
       # @!attribute wait_for_ms
       #   Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
       #   30000 (30 seconds).
       #
       #   @return [Integer, nil]
-      optional :wait_for_ms, Integer
+      optional :wait_for_ms, Integer, nil?: true
 
-      # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
+      # @!attribute zdr
+      #   Set to enabled to bypass shared caches and omit request and response content
+      #   from retained usage logs. Requires zero data retention to be enabled for your
+      #   organization (contact support@context.dev), otherwise the request fails with
+      #   ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      #
+      #   @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Zdr, nil]
+      optional :zdr, enum: -> { ContextDev::WebWebScrapeHTMLParams::Zdr }
+
+      # @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, tags: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeHTMLParams} for more details.
       #
       #   @param url [String] Full URL to scrape (must include http:// or https:// protocol)
       #
-      #   @param country [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe
+      #   @param actions [Array<ContextDev::Models::WebWebScrapeHTMLParams::Action::Wait, ContextDev::Models::WebWebScrapeHTMLParams::Action::Perform>, nil] Optional browser actions executed in array order after the page loads and before
+      #
+      #   @param country [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country] Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev r
       #
-      #   @param exclude_selectors [Array<String>] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi
+      #   @param exclude_selectors [Array<String>, nil] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi
       #
       #   @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
       #
-      #   @param include_frames [Boolean] When true, iframes are rendered inline into the returned HTML.
+      #   @param include_frames [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::IncludeFrames] When true, iframes are rendered inline into the returned HTML.
       #
-      #   @param include_selectors [Array<String>] CSS selectors. When provided, only matching subtrees (and their descendants) are
+      #   @param include_selectors [Array<String>, nil] CSS selectors. When provided, only matching subtrees (and their descendants) are
       #
-      #   @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y
+      #   @param max_age_ms [Integer, nil] Return a cached result if a prior scrape for the same parameters exists and is y
       #
       #   @param pdf [ContextDev::Models::WebWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and embedded-image
       #
-      #   @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
+      #   @param settle_animations [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::SettleAnimations] When true, waits briefly for CSS and transition animations to settle before extr
+      #
+      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
-      #   @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h
+      #   @param use_main_content_only [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::UseMainContentOnly] When true, return only the page's main content in the HTML response, excluding h
+      #
+      #   @param wait_for_ms [Integer, nil] Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
       #
-      #   @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
+      #   @param zdr [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
-      # Two-letter ISO 3166-1 alpha-2 country code for the website request location.
-      # When provided, Context.dev fetches the target page from that country.
+      # Browser action discriminated by `do`. Each variant exposes only its applicable
+      # fields.
+      module Action
+        extend ContextDev::Internal::Type::Union
+
+        discriminator :do
+
+        # Pause for a fixed number of milliseconds before continuing to the next action.
+        variant :wait, -> { ContextDev::WebWebScrapeHTMLParams::Action::Wait }
+
+        # Resolve and perform one natural-language browser action.
+        variant :perform, -> { ContextDev::WebWebScrapeHTMLParams::Action::Perform }
+
+        class Wait < ContextDev::Internal::Type::BaseModel
+          # @!attribute do_
+          #
+          #   @return [Symbol, :wait]
+          required :do_, const: :wait, api_name: :do
+
+          # @!attribute time_ms
+          #
+          #   @return [Integer]
+          required :time_ms, Integer, api_name: :timeMs
+
+          # @!method initialize(time_ms:, do_: :wait)
+          #   Pause for a fixed number of milliseconds before continuing to the next action.
+          #
+          #   @param time_ms [Integer]
+          #   @param do_ [Symbol, :wait]
+        end
+
+        class Perform < ContextDev::Internal::Type::BaseModel
+          # @!attribute action
+          #
+          #   @return [String]
+          required :action, String
+
+          # @!attribute do_
+          #
+          #   @return [Symbol, :perform]
+          required :do_, const: :perform, api_name: :do
+
+          # @!method initialize(action:, do_: :perform)
+          #   Resolve and perform one natural-language browser action.
+          #
+          #   @param action [String]
+          #   @param do_ [Symbol, :perform]
+        end
+
+        # @!method self.variants
+        #   @return [Array(ContextDev::Models::WebWebScrapeHTMLParams::Action::Wait, ContextDev::Models::WebWebScrapeHTMLParams::Action::Perform)]
+      end
+
+      # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
+      # residential proxy exit location. Must be one of Context.dev's supported
+      # countries. When provided, Context.dev fetches the target page from that country.
       module Country
         extend ContextDev::Internal::Type::Enum
 
@@ -339,6 +427,31 @@ module ContextDev
         #   @return [Array<Symbol>]
       end
 
+      # When true, iframes are rendered inline into the returned HTML.
+      module IncludeFrames
+        extend ContextDev::Internal::Type::Union
+
+        variant ContextDev::Internal::Type::Boolean
+
+        variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::IncludeFrames::TRUE }
+
+        variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::IncludeFrames::FALSE }
+
+        # @!method self.variants
+        #   @return [Array(Boolean, Symbol)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(T::Boolean, ContextDev::WebWebScrapeHTMLParams::IncludeFrames::TaggedSymbol) }
+        end
+
+        # @!group
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!endgroup
+      end
+
       class Pdf < ContextDev::Internal::Type::BaseModel
         # @!attribute end_
         #   Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
@@ -352,15 +465,17 @@ module ContextDev
         #   recognized text at each image's position in page reading order while preserving
         #   the PDF text layer. This is separate from automatic scanned-PDF OCR fallback.
         #
-        #   @return [Boolean, nil]
-        optional :ocr, ContextDev::Internal::Type::Boolean
+        #   @return [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Pdf::Ocr, nil]
+        optional :ocr, union: -> { ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr }
 
         # @!attribute should_parse
         #   When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
         #   a 400 WEBSITE_ACCESS_ERROR is returned.
         #
-        #   @return [Boolean, nil]
-        optional :should_parse, ContextDev::Internal::Type::Boolean, api_name: :shouldParse
+        #   @return [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Pdf::ShouldParse, nil]
+        optional :should_parse,
+                 union: -> { ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse },
+                 api_name: :shouldParse
 
         # @!attribute start
         #   First 1-based PDF page to parse. When omitted, parsing starts at the first page.
@@ -377,11 +492,135 @@ module ContextDev
         #
         #   @param end_ [Integer] Last 1-based PDF page to parse. When omitted, parsing ends at the last page. Mus
         #
-        #   @param ocr [Boolean] When true, detect and OCR images embedded in the selected PDF pages, inserting r
+        #   @param ocr [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Pdf::Ocr] When true, detect and OCR images embedded in the selected PDF pages, inserting r
         #
-        #   @param should_parse [Boolean] When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
+        #   @param should_parse [Boolean, Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Pdf::ShouldParse] When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
         #
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
+
+        # When true, detect and OCR images embedded in the selected PDF pages, inserting
+        # recognized text at each image's position in page reading order while preserving
+        # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback.
+        #
+        # @see ContextDev::Models::WebWebScrapeHTMLParams::Pdf#ocr
+        module Ocr
+          extend ContextDev::Internal::Type::Union
+
+          variant ContextDev::Internal::Type::Boolean
+
+          variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::Pdf::Ocr::TRUE }
+
+          variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::Pdf::Ocr::FALSE }
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Symbol)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(T::Boolean, ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::TaggedSymbol) }
+          end
+
+          # @!group
+
+          TRUE = :true
+          FALSE = :false
+
+          # @!endgroup
+        end
+
+        # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
+        # a 400 WEBSITE_ACCESS_ERROR is returned.
+        #
+        # @see ContextDev::Models::WebWebScrapeHTMLParams::Pdf#should_parse
+        module ShouldParse
+          extend ContextDev::Internal::Type::Union
+
+          variant ContextDev::Internal::Type::Boolean
+
+          variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::Pdf::ShouldParse::TRUE }
+
+          variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::Pdf::ShouldParse::FALSE }
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Symbol)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(T::Boolean, ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::TaggedSymbol) }
+          end
+
+          # @!group
+
+          TRUE = :true
+          FALSE = :false
+
+          # @!endgroup
+        end
+      end
+
+      # When true, waits briefly for CSS and transition animations to settle before
+      # extracting HTML. Defaults to false. This adds a bit of latency in exchange for
+      # more stable output on animated pages.
+      module SettleAnimations
+        extend ContextDev::Internal::Type::Union
+
+        variant ContextDev::Internal::Type::Boolean
+
+        variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::SettleAnimations::TRUE }
+
+        variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::SettleAnimations::FALSE }
+
+        # @!method self.variants
+        #   @return [Array(Boolean, Symbol)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(T::Boolean, ContextDev::WebWebScrapeHTMLParams::SettleAnimations::TaggedSymbol) }
+        end
+
+        # @!group
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!endgroup
+      end
+
+      # When true, return only the page's main content in the HTML response, excluding
+      # headers, footers, sidebars, and navigation when detectable.
+      module UseMainContentOnly
+        extend ContextDev::Internal::Type::Union
+
+        variant ContextDev::Internal::Type::Boolean
+
+        variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::UseMainContentOnly::TRUE }
+
+        variant const: -> { ContextDev::Models::WebWebScrapeHTMLParams::UseMainContentOnly::FALSE }
+
+        # @!method self.variants
+        #   @return [Array(Boolean, Symbol)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(T::Boolean, ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::TaggedSymbol) }
+        end
+
+        # @!group
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!endgroup
+      end
+
+      # Set to enabled to bypass shared caches and omit request and response content
+      # from retained usage logs. Requires zero data retention to be enabled for your
+      # organization (contact support@context.dev), otherwise the request fails with
+      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      module Zdr
+        extend ContextDev::Internal::Type::Enum
+
+        ENABLED = :enabled
+        DISABLED = :disabled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end