context.dev 2.17.1 → 2.19.0

data/lib/context_dev/models/web_screenshot_params.rb

@@ -63,6 +63,18 @@ module ContextDev
       #   @return [Boolean, nil]
       optional :handle_cookie_popup, ContextDev::Internal::Type::Boolean
 
+      # @!attribute headers
+      #   Optional outbound HTTP headers, using the same JSON object or deep-object query
+      #   format as other scrape endpoints (for example headers[Authorization]=Bearer
+      #   token). Headers are scoped to the target origin during capture. For domain/page
+      #   requests, discovery receives no custom headers and only pages on the resolved
+      #   origin are eligible. Non-empty headers bypass screenshot caching and return an
+      #   in-memory data URL; no screenshot is uploaded. Empty objects behave like omitted
+      #   headers.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :headers, ContextDev::Internal::Type::HashOf[String]
+
       # @!attribute max_age_ms
       #   Return a cached screenshot if a prior screenshot for the same parameters exists
       #   and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
@@ -125,14 +137,15 @@ module ContextDev
 
       # @!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.
+      #   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.
       #
       #   @return [Symbol, ContextDev::Models::WebScreenshotParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebScreenshotParams::Zdr }
 
-      # @!method initialize(clear_popups: nil, color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, tags: nil, timeout_opts: nil, viewport: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @!method initialize(clear_popups: nil, color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, headers: nil, max_age_ms: nil, page: nil, scroll_offset: nil, tags: nil, timeout_opts: nil, viewport: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebScreenshotParams} for more details.
       #
@@ -150,6 +163,8 @@ module ContextDev
       #
       #   @param handle_cookie_popup [Boolean] Optional parameter to control cookie/consent popup handling. If 'true', we dismi
       #
+      #   @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers, using the same JSON object or deep-object query
+      #
       #   @param max_age_ms [Integer, nil] Return a cached screenshot if a prior screenshot for the same parameters exists
       #
       #   @param page [Symbol, ContextDev::Models::WebScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy
@@ -440,7 +455,7 @@ module ContextDev
         #   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.
+        #   least 5000.
         #
         #   @return [Symbol, ContextDev::Models::WebScreenshotParams::TimeoutOpts::Behavior, nil]
         optional :behavior, enum: -> { ContextDev::WebScreenshotParams::TimeoutOpts::Behavior }
@@ -461,7 +476,7 @@ module ContextDev
         # 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.
+        # least 5000.
         #
         # @see ContextDev::Models::WebScreenshotParams::TimeoutOpts#behavior
         module Behavior
@@ -497,9 +512,10 @@ module ContextDev
       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.
+      # 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.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/lib/context_dev/models/web_screenshot_response.rb

@@ -56,8 +56,8 @@ module ContextDev
       optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata }
 
       # @!attribute screenshot
-      #   Public image URL for standard requests, or an in-memory data URL when ZDR is
-      #   enabled.
+      #   Public image URL for standard requests, or an in-memory data URL when ZDR or
+      #   non-empty custom headers are supplied.
       #
       #   @return [String, nil]
       optional :screenshot, String
@@ -100,7 +100,7 @@ module ContextDev
       #
       #   @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
-      #   @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR is ena
+      #   @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR or non
       #
       #   @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured
       #

data/lib/context_dev/models/web_search_params.rb

@@ -75,7 +75,17 @@ module ContextDev
       #   @return [ContextDev::Models::WebSearchParams::TimeoutOpts, nil]
       optional :timeout_opts, -> { ContextDev::WebSearchParams::TimeoutOpts }, api_name: :timeoutOpts
 
-      # @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_opts: nil, request_options: {})
+      # @!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.
+      #
+      #   @return [Symbol, ContextDev::Models::WebSearchParams::Zdr, nil]
+      optional :zdr, enum: -> { ContextDev::WebSearchParams::Zdr }
+
+      # @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebSearchParams} for more details.
       #
@@ -99,6 +109,8 @@ module ContextDev
       #
       #   @param timeout_opts [ContextDev::Models::WebSearchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
+      #   @param zdr [Symbol, ContextDev::Models::WebSearchParams::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 to localize results to a specific
@@ -503,7 +515,7 @@ module ContextDev
           #   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.
+          #   least 5000.
           #
           #   @return [Symbol, ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior, nil]
           optional :behavior, enum: -> { ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior }
@@ -525,7 +537,7 @@ module ContextDev
           # 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.
+          # least 5000.
           #
           # @see ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts#behavior
           module Behavior
@@ -584,6 +596,21 @@ module ContextDev
           #   @return [Array<Symbol>]
         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.
+      module Zdr
+        extend ContextDev::Internal::Type::Enum
+
+        ENABLED = :enabled
+        DISABLED = :disabled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/context_dev/models.rb

@@ -39,10 +39,6 @@ module ContextDev
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
-  AIExtractProductParams = ContextDev::Models::AIExtractProductParams
-
-  AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
-
   BatchCancelParams = ContextDev::Models::BatchCancelParams
 
   BatchDeleteParams = ContextDev::Models::BatchDeleteParams
@@ -57,8 +53,6 @@ module ContextDev
 
   BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
 
-  BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
-
   BrandSearchParams = ContextDev::Models::BrandSearchParams
 
   CrawlControls = ContextDev::Models::CrawlControls
@@ -97,6 +91,10 @@ module ContextDev
 
   MonitorRetrieveParams = ContextDev::Models::MonitorRetrieveParams
 
+  MonitorRetrieveRunParams = ContextDev::Models::MonitorRetrieveRunParams
+
+  MonitorRotateWebhookSecretParams = ContextDev::Models::MonitorRotateWebhookSecretParams
+
   MonitorRunParams = ContextDev::Models::MonitorRunParams
 
   MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
@@ -117,29 +115,19 @@ module ContextDev
 
   WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
 
-  WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams
-
-  WebExtractParams = ContextDev::Models::WebExtractParams
-
   WebExtractStyleguideParams = ContextDev::Models::WebExtractStyleguideParams
 
   WebhookDelivery = ContextDev::Models::WebhookDelivery
 
   Webhooks = ContextDev::Models::Webhooks
 
+  WebMapURLsParams = ContextDev::Models::WebMapURLsParams
+
+  WebScrapeParams = ContextDev::Models::WebScrapeParams
+
   WebScreenshotParams = ContextDev::Models::WebScreenshotParams
 
   WebSearchParams = ContextDev::Models::WebSearchParams
 
   WebWebCrawlMdParams = ContextDev::Models::WebWebCrawlMdParams
-
-  WebWebScrapeBytesParams = ContextDev::Models::WebWebScrapeBytesParams
-
-  WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams
-
-  WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams
-
-  WebWebScrapeMdParams = ContextDev::Models::WebWebScrapeMdParams
-
-  WebWebScrapeSitemapParams = ContextDev::Models::WebWebScrapeSitemapParams
 end

data/lib/context_dev/resources/brand.rb

@@ -29,42 +29,6 @@ module ContextDev
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
-      #
-      # Returns a simplified version of brand data containing only essential
-      # information: domain, title, colors, logos, and backdrops. Optimized for faster
-      # responses and reduced data transfer.
-      #
-      # @overload retrieve_simplified(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_opts: nil, request_options: {})
-      #
-      # @param domain [String] Domain name to retrieve simplified brand data for
-      #
-      # @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
-      #
-      # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
-      #
-      # @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
-      #
-      # @param timeout_opts [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::BrandRetrieveSimplifiedResponse]
-      #
-      # @see ContextDev::Models::BrandRetrieveSimplifiedParams
-      def retrieve_simplified(params)
-        parsed, options = ContextDev::BrandRetrieveSimplifiedParams.dump_request(params)
-        query = ContextDev::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "brand/retrieve-simplified",
-          query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_opts: "timeoutOpts"),
-          model: ContextDev::Models::BrandRetrieveSimplifiedResponse,
-          options: options
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BrandSearchParams} for more details.
       #

data/lib/context_dev/resources/industry.rb

@@ -8,7 +8,7 @@ module ContextDev
       #
       # Classify any brand into 2022 NAICS industry codes from its domain or name.
       #
-      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, request_options: {})
+      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
       #
       # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided,
       #
@@ -20,6 +20,8 @@ module ContextDev
       #
       # @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
+      # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ContextDev::Models::IndustryRetrieveNaicsResponse]
@@ -48,7 +50,7 @@ module ContextDev
       # domain or name. Choose between the original SIC system (`original_sic`) or the
       # latest SIC list maintained by the SEC (`latest_sec`).
       #
-      # @overload retrieve_sic(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, request_options: {})
+      # @overload retrieve_sic(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, zdr: nil, request_options: {})
       #
       # @param input [String] Brand domain or title to retrieve SIC code for. If a valid domain is provided, i
       #
@@ -62,6 +64,8 @@ module ContextDev
       #
       # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
       #
+      # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ContextDev::Models::IndustryRetrieveSicResponse]

data/lib/context_dev/resources/monitors.rb

@@ -360,6 +360,53 @@ module ContextDev
         )
       end
 
+      # Fetches one run for a monitor, including lifecycle status, timing, credits
+      # charged, and any detected change.
+      #
+      # @overload retrieve_run(run_id, monitor_id:, request_options: {})
+      #
+      # @param run_id [String]
+      # @param monitor_id [String]
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::MonitorRetrieveRunResponse]
+      #
+      # @see ContextDev::Models::MonitorRetrieveRunParams
+      def retrieve_run(run_id, params)
+        parsed, options = ContextDev::MonitorRetrieveRunParams.dump_request(params)
+        monitor_id =
+          parsed.delete(:monitor_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["monitors/%1$s/runs/%2$s", monitor_id, run_id],
+          model: ContextDev::Models::MonitorRetrieveRunResponse,
+          options: options
+        )
+      end
+
+      # Generates a new signing secret for the monitor's webhook and returns the updated
+      # monitor (including the new `webhook.secret`). The previous secret stops signing
+      # deliveries immediately, so update your endpoint before rotating.
+      #
+      # @overload rotate_webhook_secret(monitor_id, request_options: {})
+      #
+      # @param monitor_id [String]
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::MonitorRotateWebhookSecretResponse]
+      #
+      # @see ContextDev::Models::MonitorRotateWebhookSecretParams
+      def rotate_webhook_secret(monitor_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["monitors/%1$s/webhook/rotate-secret", monitor_id],
+          model: ContextDev::Models::MonitorRotateWebhookSecretResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Triggers an immediate run of the monitor outside its normal schedule. The run is
       # queued and processed asynchronously.
       #

data/lib/context_dev/resources/people.rb

@@ -11,7 +11,7 @@ module ContextDev
       # plans. Successful requests cost 20 credits. Disposable and free email addresses
       # (like gmail.com, yahoo.com) will throw a 422 error.
       #
-      # @overload enrich(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_opts: nil, request_options: {})
+      # @overload enrich(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
       #
       # @param company [ContextDev::Models::PersonEnrichParams::Company]
       #
@@ -29,6 +29,8 @@ module ContextDev
       #
       # @param timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
+      # @param zdr [Symbol, ContextDev::Models::PersonEnrichParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ContextDev::Models::PersonEnrichResponse]