context.dev 2.13.0 → 2.15.0

data/rbi/context_dev/models/ai_extract_product_response.rbi

@@ -34,8 +34,7 @@ module ContextDev
       sig { params(is_product_page: T::Boolean).void }
       attr_writer :is_product_page
 
-      # 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::AIExtractProductResponse::KeyMetadata)
@@ -103,8 +102,7 @@ module ContextDev
         cache_metadata:,
         # Whether the given URL is a product detail page
         is_product_page: 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,
         # The detected ecommerce platform, or null if not a product page
         platform: nil,
@@ -237,25 +235,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/ai_extract_products_response.rbi

@@ -27,8 +27,7 @@ module ContextDev
       end
       attr_writer :cache_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.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(ContextDev::Models::AIExtractProductsResponse::KeyMetadata)
@@ -81,8 +80,7 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_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.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
         # Array of products extracted from the website
         products: nil
@@ -208,25 +206,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/batch_cancel_response.rbi

@@ -389,11 +389,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
 
@@ -404,9 +404,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/batch_delete_response.rbi

@@ -25,8 +25,7 @@ module ContextDev
       sig { params(deleted: T::Boolean).void }
       attr_writer :deleted
 
-      # 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::BatchDeleteResponse::KeyMetadata))
       end
@@ -53,8 +52,7 @@ module ContextDev
         id: nil,
         # Always true on success.
         deleted: 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
       )
       end
@@ -80,25 +78,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/batch_get_results_response.rbi

@@ -43,8 +43,7 @@ module ContextDev
       sig { params(has_more: T::Boolean).void }
       attr_writer :has_more
 
-      # 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::BatchGetResultsResponse::KeyMetadata)
@@ -84,8 +83,7 @@ module ContextDev
         data: nil,
         # Whether another page is available.
         has_more: 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,
         # Cursor for the next page.
         next_cursor: nil
@@ -1015,25 +1013,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/batch_list_response.rbi

@@ -33,8 +33,7 @@ module ContextDev
       sig { params(has_more: T::Boolean).void }
       attr_writer :has_more
 
-      # 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::BatchListResponse::KeyMetadata))
       end
@@ -66,8 +65,7 @@ module ContextDev
         data: nil,
         # Whether another page is available.
         has_more: 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,
         # Cursor for the next page.
         next_cursor: nil
@@ -693,25 +691,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/batch_retrieve_response.rbi

@@ -137,6 +137,13 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # Batch completion delivery ID, when available.
+      sig { returns(T.nilable(String)) }
+      attr_reader :webhook_delivery_id
+
+      sig { params(webhook_delivery_id: String).void }
+      attr_writer :webhook_delivery_id
+
       sig do
         params(
           id: String,
@@ -160,7 +167,8 @@ module ContextDev
           tags: T::Array[String],
           timing: ContextDev::Models::BatchRetrieveResponse::Timing::OrHash,
           key_metadata:
-            ContextDev::Models::BatchRetrieveResponse::KeyMetadata::OrHash
+            ContextDev::Models::BatchRetrieveResponse::KeyMetadata::OrHash,
+          webhook_delivery_id: String
         ).returns(T.attached_class)
       end
       def self.new(
@@ -197,7 +205,9 @@ module ContextDev
         tags:,
         timing:,
         # API key usage for this request.
-        key_metadata: nil
+        key_metadata: nil,
+        # Batch completion delivery ID, when available.
+        webhook_delivery_id: nil
       )
       end
 
@@ -222,7 +232,9 @@ module ContextDev
               ContextDev::Models::BatchRetrieveResponse::Status::TaggedSymbol,
             tags: T::Array[String],
             timing: ContextDev::Models::BatchRetrieveResponse::Timing,
-            key_metadata: ContextDev::Models::BatchRetrieveResponse::KeyMetadata
+            key_metadata:
+              ContextDev::Models::BatchRetrieveResponse::KeyMetadata,
+            webhook_delivery_id: String
           }
         )
       end
@@ -653,11 +665,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
 
@@ -668,9 +680,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/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

@@ -445,11 +445,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 +460,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

@@ -45,8 +45,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)
@@ -89,8 +88,7 @@ module ContextDev
         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
@@ -3803,25 +3801,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

@@ -52,8 +52,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(
@@ -99,8 +98,7 @@ module ContextDev
         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
@@ -992,25 +990,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).