context.dev 2.4.0 → 2.6.0

data/rbi/context_dev/models/web_web_scrape_md_response.rbi

@@ -44,6 +44,34 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # One verified outcome per requested browser action, in request order.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied]
+          )
+        )
+      end
+      attr_reader :actions_applied
+
+      sig do
+        params(
+          actions_applied:
+            T::Array[
+              ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::OrHash
+            ]
+        ).void
+      end
+      attr_writer :actions_applied
+
+      # True when an action was applied but the returned content could not be refreshed
+      # afterward.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :actions_html_stale
+
+      sig { params(actions_html_stale: T::Boolean).void }
+      attr_writer :actions_html_stale
+
       # 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.
       sig do
@@ -70,6 +98,11 @@ module ContextDev
           success:
             ContextDev::Models::WebWebScrapeMdResponse::Success::OrBoolean,
           url: String,
+          actions_applied:
+            T::Array[
+              ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::OrHash
+            ],
+          actions_html_stale: T::Boolean,
           key_metadata:
             ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
@@ -87,6 +120,11 @@ module ContextDev
         success:,
         # The URL that was scraped
         url:,
+        # One verified outcome per requested browser action, in request order.
+        actions_applied: nil,
+        # True when an action was applied but the returned content could not be refreshed
+        # afterward.
+        actions_html_stale: nil,
         # 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.
         key_metadata: nil
@@ -102,6 +140,11 @@ module ContextDev
             success:
               ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean,
             url: String,
+            actions_applied:
+              T::Array[
+                ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied
+              ],
+            actions_html_stale: T::Boolean,
             key_metadata:
               ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata
           }
@@ -598,6 +641,143 @@ module ContextDev
         end
       end
 
+      class ActionsApplied < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :instruction
+
+        # Applied means the requested page state was visibly verified. Failed means it was
+        # not verified. Skipped means it was not attempted.
+        sig do
+          returns(
+            ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # Visible page evidence used to verify an applied action.
+        sig { returns(T.nilable(String)) }
+        attr_reader :completion_evidence
+
+        sig { params(completion_evidence: String).void }
+        attr_writer :completion_evidence
+
+        sig { returns(T.nilable(Float)) }
+        attr_reader :duration_ms
+
+        sig { params(duration_ms: Float).void }
+        attr_writer :duration_ms
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :error
+
+        sig { params(error: String).void }
+        attr_writer :error
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :method_
+
+        sig { params(method_: String).void }
+        attr_writer :method_
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :target_description
+
+        sig { params(target_description: String).void }
+        attr_writer :target_description
+
+        sig do
+          params(
+            instruction: String,
+            status:
+              ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status::OrSymbol,
+            completion_evidence: String,
+            duration_ms: Float,
+            error: String,
+            method_: String,
+            target_description: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          instruction:,
+          # Applied means the requested page state was visibly verified. Failed means it was
+          # not verified. Skipped means it was not attempted.
+          status:,
+          # Visible page evidence used to verify an applied action.
+          completion_evidence: nil,
+          duration_ms: nil,
+          error: nil,
+          method_: nil,
+          target_description: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              instruction: String,
+              status:
+                ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status::TaggedSymbol,
+              completion_evidence: String,
+              duration_ms: Float,
+              error: String,
+              method_: String,
+              target_description: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Applied means the requested page state was visibly verified. Failed means it was
+        # not verified. Skipped means it was not attempted.
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          APPLIED =
+            T.let(
+              :applied,
+              ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status::TaggedSymbol
+            )
+          SKIPPED =
+            T.let(
+              :skipped,
+              ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::WebWebScrapeMdResponse::ActionsApplied::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi

@@ -35,6 +35,23 @@ module ContextDev
       sig { params(max_links: Integer).void }
       attr_writer :max_links
 
+      # Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
+      # instead of discovering the domain's sitemaps.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sitemap_url
+
+      sig { params(sitemap_url: String).void }
+      attr_writer :sitemap_url
+
+      # 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.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
       # 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).
@@ -52,13 +69,30 @@ module ContextDev
       sig { params(url_regex: String).void }
       attr_writer :url_regex
 
+      # 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.
+      sig do
+        returns(T.nilable(ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol))
+      end
+      attr_reader :zdr
+
+      sig do
+        params(zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol).void
+      end
+      attr_writer :zdr
+
       sig do
         params(
           domain: String,
           headers: T::Hash[Symbol, String],
           max_links: Integer,
+          sitemap_url: String,
+          tags: T::Array[String],
           timeout_ms: Integer,
           url_regex: String,
+          zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -72,6 +106,13 @@ module ContextDev
         # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
         # Minimum is 1, maximum is 100,000.
         max_links: nil,
+        # Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
+        # instead of discovering the domain's sitemaps.
+        sitemap_url: nil,
+        # 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.
+        tags: nil,
         # 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).
@@ -79,6 +120,11 @@ module ContextDev
         # Optional RE2-compatible regex pattern. Only URLs matching this pattern are
         # returned and counted against maxLinks.
         url_regex: nil,
+        # 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.
+        zdr: nil,
         request_options: {}
       )
       end
@@ -89,14 +135,50 @@ module ContextDev
             domain: String,
             headers: T::Hash[Symbol, String],
             max_links: Integer,
+            sitemap_url: String,
+            tags: T::Array[String],
             timeout_ms: Integer,
             url_regex: String,
+            zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
             request_options: ContextDev::RequestOptions
           }
         )
       end
       def to_hash
       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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::WebWebScrapeSitemapParams::Zdr)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENABLED =
+          T.let(
+            :enabled,
+            ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol
+          )
+        DISABLED =
+          T.let(
+            :disabled,
+            ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models.rbi

@@ -5,11 +5,25 @@ 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
 
+  Error = ContextDev::Models::Error
+
+  ErrorCount = ContextDev::Models::ErrorCount
+
   IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
 
   IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
@@ -18,6 +32,10 @@ module ContextDev
 
   MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
 
+  MonitorGetCreditUsageParams = ContextDev::Models::MonitorGetCreditUsageParams
+
+  MonitorGetLimitsParams = ContextDev::Models::MonitorGetLimitsParams
+
   MonitorListAccountChangesParams =
     ContextDev::Models::MonitorListAccountChangesParams
 

data/rbi/context_dev/resources/ai.rbi

@@ -9,6 +9,7 @@ module ContextDev
         params(
           url: String,
           max_age_ms: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::AIExtractProductResponse)
@@ -20,6 +21,8 @@ module ContextDev
         # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
         # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
         max_age_ms: nil,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: nil,
         # 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).

data/rbi/context_dev/resources/batch.rbi

@@ -0,0 +1,120 @@
+# typed: strong
+
+module ContextDev
+  module Resources
+    class Batch
+      # Check progress and get download links when the batch finishes. Also returns the
+      # rejected-URL list and webhook signing secret from submission, so nothing is lost
+      # if the submit response was dropped.
+      sig do
+        params(
+          batch_id: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::BatchRetrieveResponse)
+      end
+      def retrieve(
+        # ID of the batch to retrieve or cancel.
+        batch_id,
+        request_options: {}
+      )
+      end
+
+      # List your batches from newest to oldest. Filter by status or continue with a
+      # cursor.
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          q: String,
+          search_type: ContextDev::BatchListParams::SearchType::OrSymbol,
+          status: ContextDev::BatchListParams::Status::OrSymbol,
+          tags: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::BatchListResponse)
+      end
+      def list(
+        # Cursor from the previous page.
+        cursor: nil,
+        # Batches per page. Defaults to 25.
+        limit: nil,
+        # Free-text search term, matched against the batch id, crawl source (start URL or
+        # sitemap domain), and tags.
+        q: nil,
+        # `prefix` for as-you-type prefix matching (default), `exact` for full-token
+        # matching.
+        search_type: nil,
+        # Filter by status.
+        status: nil,
+        # Comma-separated list of tags to filter by (matches batches having any of them).
+        tags: nil,
+        request_options: {}
+      )
+      end
+
+      # Stop a batch from starting new pages. In-progress pages finish, and unused
+      # credits are refunded.
+      sig do
+        params(
+          batch_id: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::BatchCancelResponse)
+      end
+      def cancel(
+        # ID of the batch to retrieve or cancel.
+        batch_id,
+        request_options: {}
+      )
+      end
+
+      # Page through the result records of a finished batch as JSON, in the same order
+      # as the downloadable result files. Use this instead of downloading and parsing
+      # the NDJSON files yourself.
+      sig do
+        params(
+          batch_id: String,
+          cursor: String,
+          limit: Integer,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::BatchGetResultsResponse)
+      end
+      def get_results(
+        # ID of the batch to retrieve or cancel.
+        batch_id,
+        # next_cursor from the previous page.
+        cursor: nil,
+        # Records per page. Defaults to 25. A page can close early so its payload stays
+        # under ~8 MB; rely on next_cursor rather than counting records.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve and normalize a person profile from identifiers.
+      sig do
+        params(
+          identifiers: ContextDev::BatchSubmitParams::Identifiers::OrHash,
+          tags: T::Array[String],
+          timeout_ms: Integer,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::BatchSubmitResponse)
+      end
+      def submit(
+        # Known identifiers for the person. At least one identifier is required.
+        identifiers:,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: nil,
+        # 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).
+        timeout_ms: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ContextDev::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/context_dev/resources/brand.rbi

@@ -35,7 +35,9 @@ module ContextDev
       sig do
         params(
           domain: String,
-          max_age_ms: Integer,
+          max_age_ms: T.nilable(Integer),
+          tags: T::Array[String],
+          theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::BrandRetrieveSimplifiedResponse)
@@ -48,6 +50,12 @@ module ContextDev
         # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
         # year.
         max_age_ms: nil,
+        # 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.
+        tags: nil,
+        # Optional theme preference used when selecting brand assets.
+        theme: nil,
         # 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).

data/rbi/context_dev/resources/industry.rbi

@@ -9,6 +9,7 @@ module ContextDev
           input: String,
           max_results: Integer,
           min_results: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::IndustryRetrieveNaicsResponse)
@@ -23,6 +24,10 @@ module ContextDev
         max_results: nil,
         # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
         min_results: nil,
+        # 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.
+        tags: nil,
         # 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).
@@ -39,6 +44,7 @@ module ContextDev
           input: String,
           max_results: Integer,
           min_results: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
@@ -53,6 +59,10 @@ module ContextDev
         max_results: nil,
         # Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
         min_results: nil,
+        # 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.
+        tags: nil,
         # 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).