context.dev 2.14.0 → 2.16.0

data/rbi/context_dev/models/batch_submit_params.rbi

@@ -29,7 +29,18 @@ module ContextDev
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # URL notified when the batch finishes.
+      # Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
+      # preserves legacy delivery; retry: {} opts into durable retries.
+      sig { returns(T.nilable(ContextDev::BatchSubmitParams::Webhook)) }
+      attr_reader :webhook
+
+      sig do
+        params(webhook: ContextDev::BatchSubmitParams::Webhook::OrHash).void
+      end
+      attr_writer :webhook
+
+      # Legacy URL notified when the batch finishes. Preserves one best-effort attempt.
+      # Cannot be combined with webhook.
       sig { returns(T.nilable(String)) }
       attr_reader :webhook_url
 
@@ -52,6 +63,7 @@ module ContextDev
               ContextDev::BatchSubmitParams::Input::Crawl::OrHash
             ),
           tags: T::Array[String],
+          webhook: ContextDev::BatchSubmitParams::Webhook::OrHash,
           webhook_url: String,
           idempotency_key: String,
           request_options: ContextDev::RequestOptions::OrHash
@@ -62,7 +74,11 @@ module ContextDev
         input:,
         # Tags stored on the batch. Filter the batch list by them later.
         tags: nil,
-        # URL notified when the batch finishes.
+        # Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
+        # preserves legacy delivery; retry: {} opts into durable retries.
+        webhook: nil,
+        # Legacy URL notified when the batch finishes. Preserves one best-effort attempt.
+        # Cannot be combined with webhook.
         webhook_url: nil,
         # Any string unique to this submission. Retries with the same key return the
         # original batch.
@@ -80,6 +96,7 @@ module ContextDev
                 ContextDev::BatchSubmitParams::Input::Crawl
               ),
             tags: T::Array[String],
+            webhook: ContextDev::BatchSubmitParams::Webhook,
             webhook_url: String,
             idempotency_key: String,
             request_options: ContextDev::RequestOptions
@@ -6477,6 +6494,46 @@ module ContextDev
         def self.variants
         end
       end
+
+      class Webhook < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::BatchSubmitParams::Webhook,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :url
+
+        # Webhook retry settings. Use {} for the default schedule.
+        sig { returns(T.nilable(ContextDev::RetryConfig)) }
+        attr_reader :retry_
+
+        sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
+        attr_writer :retry_
+
+        # Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
+        # preserves legacy delivery; retry: {} opts into durable retries.
+        sig do
+          params(url: String, retry_: ContextDev::RetryConfig::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          url:,
+          # Webhook retry settings. Use {} for the default schedule.
+          retry_: nil
+        )
+        end
+
+        sig do
+          override.returns({ url: String, retry_: ContextDev::RetryConfig })
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/batch_submit_response.rbi

@@ -77,6 +77,11 @@ module ContextDev
       end
       attr_accessor :mode
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Always `queued`. An accepted batch has not started yet.
       sig do
         returns(ContextDev::Models::BatchSubmitResponse::Status::TaggedSymbol)
@@ -124,6 +129,7 @@ module ContextDev
               ContextDev::Models::BatchSubmitResponse::InvalidURL::OrHash
             ],
           mode: ContextDev::Models::BatchSubmitResponse::Mode::OrSymbol,
+          request_id: String,
           status: ContextDev::Models::BatchSubmitResponse::Status::OrSymbol,
           tags: T::Array[String],
           key_metadata:
@@ -153,6 +159,9 @@ module ContextDev
         invalid_urls:,
         # How pages will be selected.
         mode:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Always `queued`. An accepted batch has not started yet.
         status:,
         # Tags stored on the batch.
@@ -180,6 +189,7 @@ module ContextDev
             invalid_urls:
               T::Array[ContextDev::Models::BatchSubmitResponse::InvalidURL],
             mode: ContextDev::Models::BatchSubmitResponse::Mode::TaggedSymbol,
+            request_id: String,
             status:
               ContextDev::Models::BatchSubmitResponse::Status::TaggedSymbol,
             tags: T::Array[String],
@@ -445,11 +455,11 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
@@ -460,9 +470,9 @@ module ContextDev
           )
         end
         def self.new(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/brand_retrieve_response.rbi

@@ -25,6 +25,11 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Detailed brand information
       sig do
         returns(T.nilable(ContextDev::Models::BrandRetrieveResponse::Brand))
@@ -45,8 +50,7 @@ module ContextDev
       sig { params(code: Integer).void }
       attr_writer :code
 
-      # 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.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(ContextDev::Models::BrandRetrieveResponse::KeyMetadata)
@@ -73,6 +77,7 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::BrandRetrieveResponse::CacheMetadata::OrHash,
+          request_id: String,
           brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash,
           code: Integer,
           key_metadata:
@@ -85,12 +90,14 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_metadata:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Detailed brand information
         brand: nil,
         # HTTP status code
         code: 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.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
         # Status of the response, e.g., 'ok'
         status: nil
@@ -102,6 +109,7 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::BrandRetrieveResponse::CacheMetadata,
+            request_id: String,
             brand: ContextDev::Models::BrandRetrieveResponse::Brand,
             code: Integer,
             key_metadata:
@@ -3803,25 +3811,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # 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.
+        # Credit usage, included whenever a valid API key is provided.
         sig do
           params(credits_consumed: Integer, credits_remaining: Integer).returns(
             T.attached_class
           )
         end
         def self.new(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi

@@ -25,9 +25,8 @@ module ContextDev
       sig { returns(T.nilable(Integer)) }
       attr_accessor :max_age_ms
 
-      # 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.
+      # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      # characters.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -76,9 +75,8 @@ 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.
+        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+        # characters.
         tags: nil,
         # Optional theme preference used when selecting brand assets.
         theme: nil,

data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi

@@ -29,6 +29,11 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Simplified brand information
       sig do
         returns(
@@ -52,8 +57,7 @@ module ContextDev
       sig { params(code: Integer).void }
       attr_writer :code
 
-      # 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.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(
@@ -82,6 +86,7 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::OrHash,
+          request_id: String,
           brand:
             ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash,
           code: Integer,
@@ -95,12 +100,14 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_metadata:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Simplified brand information
         brand: nil,
         # HTTP status code of the response
         code: 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.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
         # Status of the response, e.g., 'ok'
         status: nil
@@ -112,6 +119,7 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata,
+            request_id: String,
             brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand,
             code: Integer,
             key_metadata:
@@ -992,25 +1000,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # 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.
+        # Credit usage, included whenever a valid API key is provided.
         sig do
           params(credits_consumed: Integer, credits_remaining: Integer).returns(
             T.attached_class
           )
         end
         def self.new(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/brand_search_params.rbi

@@ -40,9 +40,8 @@ module ContextDev
       end
       attr_writer :query_by
 
-      # 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.
+      # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      # characters.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -77,9 +76,8 @@ module ContextDev
         # Fields to match the search term against, as a comma-separated list or repeated
         # parameter: 'name', 'domain', or both. Defaults to both.
         query_by: 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.
+        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+        # characters.
         tags: nil,
         # Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
         # typo tolerance).

data/rbi/context_dev/models/brand_search_response.rbi

@@ -11,13 +11,17 @@ module ContextDev
           )
         end
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Up to 10 matching brands, name matches first, then domain matches, most popular
       # first within each group. Empty when nothing matches.
       sig { returns(T::Array[ContextDev::Models::BrandSearchResponse::Result]) }
       attr_accessor :results
 
-      # 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.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(T.nilable(ContextDev::Models::BrandSearchResponse::KeyMetadata))
       end
@@ -33,6 +37,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           results:
             T::Array[ContextDev::Models::BrandSearchResponse::Result::OrHash],
           key_metadata:
@@ -40,11 +45,13 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Up to 10 matching brands, name matches first, then domain matches, most popular
         # first within each group. Empty when nothing matches.
         results:,
-        # 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.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil
       )
       end
@@ -52,6 +59,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             results: T::Array[ContextDev::Models::BrandSearchResponse::Result],
             key_metadata: ContextDev::Models::BrandSearchResponse::KeyMetadata
           }
@@ -112,25 +120,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # 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.
+        # Credit usage, included whenever a valid API key is provided.
         sig do
           params(credits_consumed: Integer, credits_remaining: Integer).returns(
             T.attached_class
           )
         end
         def self.new(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/industry_retrieve_naics_params.rbi

@@ -35,9 +35,8 @@ module ContextDev
       sig { params(min_results: Integer).void }
       attr_writer :min_results
 
-      # 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.
+      # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      # characters.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -73,9 +72,8 @@ 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.
+        # Comma-separated tags for tracking request usage. 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

data/rbi/context_dev/models/industry_retrieve_naics_response.rbi

@@ -11,6 +11,11 @@ module ContextDev
           )
         end
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Array of NAICS codes and titles.
       sig do
         returns(
@@ -38,8 +43,7 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
-      # 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.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(
@@ -73,6 +77,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           codes:
             T::Array[
               ContextDev::Models::IndustryRetrieveNaicsResponse::Code::OrHash
@@ -85,12 +90,14 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Array of NAICS codes and titles.
         codes: nil,
         # Domain found for the brand
         domain: 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.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
         # Status of the response, e.g., 'ok'
         status: nil,
@@ -102,6 +109,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             codes:
               T::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code],
             domain: String,
@@ -221,25 +229,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # 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.
+        # Credit usage, included whenever a valid API key is provided.
         sig do
           params(credits_consumed: Integer, credits_remaining: Integer).returns(
             T.attached_class
           )
         end
         def self.new(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/industry_retrieve_sic_params.rbi

@@ -34,9 +34,8 @@ module ContextDev
       sig { params(min_results: Integer).void }
       attr_writer :min_results
 
-      # 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.
+      # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      # characters.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -87,9 +86,8 @@ 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.
+        # Comma-separated tags for tracking request usage. 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