context.dev 2.5.0 → 2.7.0

data/lib/context_dev/models/web_web_scrape_md_response.rb

@@ -36,6 +36,21 @@ module ContextDev
       #   @return [String]
       required :url, String
 
+      # @!attribute actions_applied
+      #   One verified outcome per requested browser action, in request order.
+      #
+      #   @return [Array<ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied>, nil]
+      optional :actions_applied,
+               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied] },
+               api_name: :actionsApplied
+
+      # @!attribute actions_html_stale
+      #   True when an action was applied but the returned content could not be refreshed
+      #   afterward.
+      #
+      #   @return [Boolean, nil]
+      optional :actions_html_stale, ContextDev::Internal::Type::Boolean, api_name: :actionsHtmlStale
+
       # @!attribute key_metadata
       #   Metadata about the API key used for the request. Included in every response
       #   whenever a valid API key is provided, even when the response status is not 200.
@@ -43,7 +58,7 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }
 
-      # @!method initialize(content_length:, markdown:, metadata:, success:, url:, key_metadata: nil)
+      # @!method initialize(content_length:, markdown:, metadata:, success:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeMdResponse} for more details.
       #
@@ -57,6 +72,10 @@ module ContextDev
       #
       #   @param url [String] The URL that was scraped
       #
+      #   @param actions_applied [Array<ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied>] One verified outcome per requested browser action, in request order.
+      #
+      #   @param actions_html_stale [Boolean] True when an action was applied but the returned content could not be refreshed
+      #
       #   @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       # @see ContextDev::Models::WebWebScrapeMdResponse#metadata
@@ -318,6 +337,79 @@ module ContextDev
         #   @return [Array<Boolean>]
       end
 
+      class ActionsApplied < ContextDev::Internal::Type::BaseModel
+        # @!attribute instruction
+        #
+        #   @return [String]
+        required :instruction, String
+
+        # @!attribute status
+        #   Applied means the requested page state was visibly verified. Failed means it was
+        #   not verified. Skipped means it was not attempted.
+        #
+        #   @return [Symbol, ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status]
+        required :status, enum: -> { ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status }
+
+        # @!attribute completion_evidence
+        #   Visible page evidence used to verify an applied action.
+        #
+        #   @return [String, nil]
+        optional :completion_evidence, String, api_name: :completionEvidence
+
+        # @!attribute duration_ms
+        #
+        #   @return [Float, nil]
+        optional :duration_ms, Float, api_name: :durationMs
+
+        # @!attribute error
+        #
+        #   @return [String, nil]
+        optional :error, String
+
+        # @!attribute method_
+        #
+        #   @return [String, nil]
+        optional :method_, String, api_name: :method
+
+        # @!attribute target_description
+        #
+        #   @return [String, nil]
+        optional :target_description, String, api_name: :targetDescription
+
+        # @!method initialize(instruction:, status:, completion_evidence: nil, duration_ms: nil, error: nil, method_: nil, target_description: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied} for more details.
+        #
+        #   @param instruction [String]
+        #
+        #   @param status [Symbol, ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status] Applied means the requested page state was visibly verified. Failed means it was
+        #
+        #   @param completion_evidence [String] Visible page evidence used to verify an applied action.
+        #
+        #   @param duration_ms [Float]
+        #
+        #   @param error [String]
+        #
+        #   @param method_ [String]
+        #
+        #   @param target_description [String]
+
+        # Applied means the requested page state was visibly verified. Failed means it was
+        # not verified. Skipped means it was not attempted.
+        #
+        # @see ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          APPLIED = :applied
+          FAILED = :failed
+          SKIPPED = :skipped
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::WebWebScrapeMdResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models.rb

@@ -43,14 +43,30 @@ module ContextDev
 
   AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
 
+  BatchCancelParams = ContextDev::Models::BatchCancelParams
+
+  BatchGetResultsParams = ContextDev::Models::BatchGetResultsParams
+
+  BatchListParams = ContextDev::Models::BatchListParams
+
+  BatchRetrieveParams = ContextDev::Models::BatchRetrieveParams
+
+  BatchSubmitParams = ContextDev::Models::BatchSubmitParams
+
   BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
 
   BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
 
+  CrawlControls = ContextDev::Models::CrawlControls
+
+  Failure = ContextDev::Models::Failure
+
   IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
 
   IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
 
+  Intake = ContextDev::Models::Intake
+
   MonitorCreateParams = ContextDev::Models::MonitorCreateParams
 
   MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
@@ -77,6 +93,8 @@ module ContextDev
 
   MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
 
+  PageErrorCount = ContextDev::Models::PageErrorCount
+
   ParseHandleParams = ContextDev::Models::ParseHandleParams
 
   UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams

data/lib/context_dev/resources/batch.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Resources
+    class Batch
+      # Check progress, and get download links once the batch finishes.
+      #
+      # @overload retrieve(batch_id, request_options: {})
+      #
+      # @param batch_id [String] ID of the batch to retrieve or cancel.
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::BatchRetrieveResponse]
+      #
+      # @see ContextDev::Models::BatchRetrieveParams
+      def retrieve(batch_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["batch/%1$s", batch_id],
+          model: ContextDev::Models::BatchRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::BatchListParams} for more details.
+      #
+      # List your batches from newest to oldest. Filter by status or continue with a
+      # cursor.
+      #
+      # @overload list(cursor: nil, limit: nil, q: nil, search_type: nil, status: nil, tags: nil, request_options: {})
+      #
+      # @param cursor [String] Cursor from the previous page.
+      #
+      # @param limit [Integer] Batches per page. Defaults to 25.
+      #
+      # @param q [String] Free-text search term, matched against the batch id, crawl source (start URL or
+      #
+      # @param search_type [Symbol, ContextDev::Models::BatchListParams::SearchType] `prefix` for as-you-type prefix matching (default), `exact` for full-token match
+      #
+      # @param status [Symbol, ContextDev::Models::BatchListParams::Status] Filter by status.
+      #
+      # @param tags [String] Comma-separated list of tags to filter by (matches batches having any of them).
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::BatchListResponse]
+      #
+      # @see ContextDev::Models::BatchListParams
+      def list(params = {})
+        parsed, options = ContextDev::BatchListParams.dump_request(params)
+        query = ContextDev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "batch/list",
+          query: query,
+          model: ContextDev::Models::BatchListResponse,
+          options: options
+        )
+      end
+
+      # Stop a batch from starting new pages. In-progress pages finish, and unused
+      # credits are refunded.
+      #
+      # @overload cancel(batch_id, request_options: {})
+      #
+      # @param batch_id [String] ID of the batch to retrieve or cancel.
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::BatchCancelResponse]
+      #
+      # @see ContextDev::Models::BatchCancelParams
+      def cancel(batch_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["batch/%1$s/cancel", batch_id],
+          model: ContextDev::Models::BatchCancelResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::BatchGetResultsParams} for more details.
+      #
+      # Page through a finished batch's results as JSON instead of downloading the
+      # NDJSON files.
+      #
+      # @overload get_results(batch_id, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param batch_id [String] ID of the batch to retrieve or cancel.
+      #
+      # @param cursor [String] next_cursor from the previous page.
+      #
+      # @param limit [Integer] Records per page. Defaults to 25. A page can close early so its payload stays un
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::BatchGetResultsResponse]
+      #
+      # @see ContextDev::Models::BatchGetResultsParams
+      def get_results(batch_id, params = {})
+        parsed, options = ContextDev::BatchGetResultsParams.dump_request(params)
+        query = ContextDev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["batch/%1$s/results", batch_id],
+          query: query,
+          model: ContextDev::Models::BatchGetResultsResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::BatchSubmitParams} for more details.
+      #
+      # Retrieve and normalize a person profile from identifiers.
+      #
+      # @overload submit(identifiers:, tags: nil, timeout_ms: nil, request_options: {})
+      #
+      # @param identifiers [ContextDev::Models::BatchSubmitParams::Identifiers] Known identifiers for the person. At least one identifier is required.
+      #
+      # @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 request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::BatchSubmitResponse]
+      #
+      # @see ContextDev::Models::BatchSubmitParams
+      def submit(params)
+        parsed, options = ContextDev::BatchSubmitParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "people/retrieve",
+          body: parsed,
+          model: ContextDev::Models::BatchSubmitResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ContextDev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/context_dev/resources/monitors.rb

@@ -14,18 +14,18 @@ module ContextDev
       # detection combinations. The monitor runs immediately after creation to create
       # its initial baseline.
       #
-      # @overload create(change_detection:, name:, schedule:, target:, mode: nil, tags: nil, webhook: nil, request_options: {})
-      #
-      # @param change_detection [ContextDev::Models::MonitorCreateParams::ChangeDetection::Exact, ContextDev::Models::MonitorCreateParams::ChangeDetection::Semantic] Discriminated union describing how changes are detected.
+      # @overload create(name:, target:, change_detection: nil, mode: nil, schedule: nil, tags: nil, webhook: nil, request_options: {})
       #
       # @param name [String]
       #
-      # @param schedule [ContextDev::Models::MonitorCreateParams::Schedule] Run the monitor on a fixed interval defined by a frequency and a unit, e.g. ever
-      #
       # @param target [ContextDev::Models::MonitorCreateParams::Target::Page, ContextDev::Models::MonitorCreateParams::Target::Sitemap, ContextDev::Models::MonitorCreateParams::Target::Extract] Discriminated union describing what the monitor watches.
       #
+      # @param change_detection [ContextDev::Models::MonitorCreateParams::ChangeDetection::Exact, ContextDev::Models::MonitorCreateParams::ChangeDetection::Semantic] Discriminated union describing how changes are detected.
+      #
       # @param mode [Symbol, ContextDev::Models::MonitorCreateParams::Mode] Top-level monitor category. Always `web` today; the concrete behavior is describ
       #
+      # @param schedule [ContextDev::Models::MonitorCreateParams::Schedule] Run the monitor on a fixed interval defined by a frequency and a unit, e.g. ever
+      #
       # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
       #
       # @param webhook [ContextDev::Models::MonitorCreateParams::Webhook, nil]

data/lib/context_dev/resources/web.rb

@@ -180,7 +180,7 @@ module ContextDev
       #
       # @param color_scheme [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig
       #
-      # @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev r
+      # @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
       #
       # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https
       #
@@ -285,7 +285,7 @@ module ContextDev
       #
       # @param url [String] The starting URL for the crawl (must include http:// or https:// protocol)
       #
-      # @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country] Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev r
+      # @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
       #
       # @param exclude_selectors [Array<String>] CSS selectors to remove before each crawled page is converted to Markdown. Appli
       #
@@ -353,7 +353,7 @@ module ContextDev
       #
       # @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 country [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
       #
       # @param exclude_selectors [Array<String>, nil] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi
       #
@@ -481,7 +481,7 @@ module ContextDev
       #
       # @param actions [Array<ContextDev::Models::WebWebScrapeMdParams::Action::Wait, ContextDev::Models::WebWebScrapeMdParams::Action::Perform>, nil] Optional browser actions executed in array order after the page loads and before
       #
-      # @param country [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country] Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev r
+      # @param country [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
       #
       # @param exclude_selectors [Array<String>, nil] CSS selectors to remove before conversion to Markdown. Applied after includeSele
       #

data/lib/context_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContextDev
-  VERSION = "2.5.0"
+  VERSION = "2.7.0"
 end

data/lib/context_dev.rb

@@ -56,14 +56,27 @@ require_relative "context_dev/models/ai_extract_product_params"
 require_relative "context_dev/models/ai_extract_product_response"
 require_relative "context_dev/models/ai_extract_products_params"
 require_relative "context_dev/models/ai_extract_products_response"
+require_relative "context_dev/models/batch_cancel_params"
+require_relative "context_dev/models/batch_cancel_response"
+require_relative "context_dev/models/batch_get_results_params"
+require_relative "context_dev/models/batch_get_results_response"
+require_relative "context_dev/models/batch_list_params"
+require_relative "context_dev/models/batch_list_response"
+require_relative "context_dev/models/batch_retrieve_params"
+require_relative "context_dev/models/batch_retrieve_response"
+require_relative "context_dev/models/batch_submit_params"
+require_relative "context_dev/models/batch_submit_response"
 require_relative "context_dev/models/brand_retrieve_params"
 require_relative "context_dev/models/brand_retrieve_response"
 require_relative "context_dev/models/brand_retrieve_simplified_params"
 require_relative "context_dev/models/brand_retrieve_simplified_response"
+require_relative "context_dev/models/crawl_controls"
+require_relative "context_dev/models/failure"
 require_relative "context_dev/models/industry_retrieve_naics_params"
 require_relative "context_dev/models/industry_retrieve_naics_response"
 require_relative "context_dev/models/industry_retrieve_sic_params"
 require_relative "context_dev/models/industry_retrieve_sic_response"
+require_relative "context_dev/models/intake"
 require_relative "context_dev/models/monitor_create_params"
 require_relative "context_dev/models/monitor_create_response"
 require_relative "context_dev/models/monitor_delete_params"
@@ -90,6 +103,7 @@ require_relative "context_dev/models/monitor_run_params"
 require_relative "context_dev/models/monitor_run_response"
 require_relative "context_dev/models/monitor_update_params"
 require_relative "context_dev/models/monitor_update_response"
+require_relative "context_dev/models/page_error_count"
 require_relative "context_dev/models/parse_handle_params"
 require_relative "context_dev/models/parse_handle_response"
 require_relative "context_dev/models/utility_prefetch_params"
@@ -119,6 +133,7 @@ require_relative "context_dev/models/web_web_scrape_sitemap_params"
 require_relative "context_dev/models/web_web_scrape_sitemap_response"
 require_relative "context_dev/models"
 require_relative "context_dev/resources/ai"
+require_relative "context_dev/resources/batch"
 require_relative "context_dev/resources/brand"
 require_relative "context_dev/resources/industry"
 require_relative "context_dev/resources/monitors"

data/rbi/context_dev/client.rbi

@@ -38,6 +38,9 @@ module ContextDev
     sig { returns(ContextDev::Resources::Monitors) }
     attr_reader :monitors
 
+    sig { returns(ContextDev::Resources::Batch) }
+    attr_reader :batch
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/context_dev/models/batch_cancel_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BatchCancelParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::BatchCancelParams, ContextDev::Internal::AnyHash)
+        end
+
+      # ID of the batch to retrieve or cancel.
+      sig { returns(String) }
+      attr_accessor :batch_id
+
+      sig do
+        params(
+          batch_id: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ID of the batch to retrieve or cancel.
+        batch_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { batch_id: String, request_options: ContextDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end