context.dev 2.14.0 → 2.16.0

data/lib/context_dev.rb

@@ -52,6 +52,7 @@ require_relative "context_dev/errors"
 require_relative "context_dev/internal/transport/base_client"
 require_relative "context_dev/internal/transport/pooled_net_requester"
 require_relative "context_dev/client"
+require_relative "context_dev/models/webhooks/delivery"
 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"
@@ -81,6 +82,10 @@ 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/log_list_params"
+require_relative "context_dev/models/log_list_response"
+require_relative "context_dev/models/log_retrieve_params"
+require_relative "context_dev/models/log_retrieve_response"
 require_relative "context_dev/models/monitor_create_params"
 require_relative "context_dev/models/monitor_create_response"
 require_relative "context_dev/models/monitor_delete_params"
@@ -114,6 +119,7 @@ require_relative "context_dev/models/parse_handle_params"
 require_relative "context_dev/models/parse_handle_response"
 require_relative "context_dev/models/person_enrich_params"
 require_relative "context_dev/models/person_enrich_response"
+require_relative "context_dev/models/retry_config"
 require_relative "context_dev/models/utility_prefetch_params"
 require_relative "context_dev/models/utility_prefetch_response"
 require_relative "context_dev/models/web_extract_competitors_params"
@@ -125,6 +131,16 @@ require_relative "context_dev/models/web_extract_response"
 require_relative "context_dev/models/web_extract_styleguide_params"
 require_relative "context_dev/models/web_extract_styleguide_response"
 require_relative "context_dev/models/webhook_delivery"
+require_relative "context_dev/models/webhooks/attempt"
+require_relative "context_dev/models/webhooks/delivery_list_attempts_params"
+require_relative "context_dev/models/webhooks/delivery_list_attempts_response"
+require_relative "context_dev/models/webhooks/delivery_list_params"
+require_relative "context_dev/models/webhooks/delivery_list_response"
+require_relative "context_dev/models/webhooks/delivery_retrieve_params"
+require_relative "context_dev/models/webhooks/delivery_retrieve_response"
+require_relative "context_dev/models/webhooks/delivery_retry_params"
+require_relative "context_dev/models/webhooks/delivery_retry_response"
+require_relative "context_dev/models/webhooks/delivery_summary"
 require_relative "context_dev/models/web_screenshot_params"
 require_relative "context_dev/models/web_screenshot_response"
 require_relative "context_dev/models/web_search_params"
@@ -144,9 +160,12 @@ 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/logs"
 require_relative "context_dev/resources/monitors"
 require_relative "context_dev/resources/news"
 require_relative "context_dev/resources/parse"
 require_relative "context_dev/resources/people"
 require_relative "context_dev/resources/utility"
 require_relative "context_dev/resources/web"
+require_relative "context_dev/resources/webhooks"
+require_relative "context_dev/resources/webhooks/deliveries"

data/rbi/context_dev/client.rbi

@@ -42,6 +42,9 @@ module ContextDev
     sig { returns(ContextDev::Resources::Batch) }
     attr_reader :batch
 
+    sig { returns(ContextDev::Resources::Webhooks) }
+    attr_reader :webhooks
+
     sig { returns(ContextDev::Resources::People) }
     attr_reader :people
 
@@ -49,6 +52,11 @@ module ContextDev
     sig { returns(ContextDev::Resources::News) }
     attr_reader :news
 
+    # Read your organization's API request logs to debug failed calls. These endpoints
+    # cost no credits and use a separate rate limit.
+    sig { returns(ContextDev::Resources::Logs) }
+    attr_reader :logs
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/context_dev/models/ai_extract_product_response.rbi

@@ -27,6 +27,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
+
       # Whether the given URL is a product detail page
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :is_product_page
@@ -34,8 +39,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)
@@ -83,6 +87,7 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::AIExtractProductResponse::CacheMetadata::OrHash,
+          request_id: String,
           is_product_page: T::Boolean,
           key_metadata:
             ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash,
@@ -101,10 +106,12 @@ 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:,
         # 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,
@@ -118,6 +125,7 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::AIExtractProductResponse::CacheMetadata,
+            request_id: String,
             is_product_page: T::Boolean,
             key_metadata:
               ContextDev::Models::AIExtractProductResponse::KeyMetadata,
@@ -237,25 +245,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,12 @@ 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.
+      # 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
+
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(ContextDev::Models::AIExtractProductsResponse::KeyMetadata)
@@ -68,6 +72,7 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::AIExtractProductsResponse::CacheMetadata::OrHash,
+          request_id: String,
           key_metadata:
             ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash,
           products:
@@ -81,8 +86,10 @@ 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.
+        # 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:,
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
         # Array of products extracted from the website
         products: nil
@@ -94,6 +101,7 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::AIExtractProductsResponse::CacheMetadata,
+            request_id: String,
             key_metadata:
               ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
             products:
@@ -208,25 +216,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

@@ -68,6 +68,11 @@ module ContextDev
       end
       attr_writer :progress
 
+      # 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 `cancelling`. Work already in flight finishes; the batch reaches
       # `cancelled` shortly after.
       sig do
@@ -114,6 +119,7 @@ module ContextDev
           mode: ContextDev::Models::BatchCancelResponse::Mode::OrSymbol,
           page_errors: T::Array[ContextDev::PageErrorCount::OrHash],
           progress: ContextDev::Models::BatchCancelResponse::Progress::OrHash,
+          request_id: String,
           status: ContextDev::Models::BatchCancelResponse::Status::OrSymbol,
           tags: T::Array[String],
           timing: ContextDev::Models::BatchCancelResponse::Timing::OrHash,
@@ -139,6 +145,9 @@ module ContextDev
         page_errors:,
         # How far the batch got before cancellation.
         progress:,
+        # 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 `cancelling`. Work already in flight finishes; the batch reaches
         # `cancelled` shortly after.
         status:,
@@ -163,6 +172,7 @@ module ContextDev
             mode: ContextDev::Models::BatchCancelResponse::Mode::TaggedSymbol,
             page_errors: T::Array[ContextDev::PageErrorCount],
             progress: ContextDev::Models::BatchCancelResponse::Progress,
+            request_id: String,
             status:
               ContextDev::Models::BatchCancelResponse::Status::TaggedSymbol,
             tags: T::Array[String],
@@ -389,11 +399,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 +414,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

@@ -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
+
       # ID of the deleted batch.
       sig { returns(T.nilable(String)) }
       attr_reader :id
@@ -25,8 +30,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
@@ -42,6 +46,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           id: String,
           deleted: T::Boolean,
           key_metadata:
@@ -49,12 +54,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:,
         # ID of the deleted batch.
         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
@@ -62,6 +69,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             id: String,
             deleted: T::Boolean,
             key_metadata: ContextDev::Models::BatchDeleteResponse::KeyMetadata
@@ -80,25 +88,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

@@ -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
+
       # Result records on this page.
       sig do
         returns(
@@ -43,8 +48,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)
@@ -66,6 +70,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           data:
             T::Array[
               T.any(
@@ -80,12 +85,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:,
         # Result records on this page.
         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
@@ -95,6 +102,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             data:
               T::Array[
                 ContextDev::Models::BatchGetResultsResponse::Data::Variants
@@ -1015,25 +1023,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

@@ -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
+
       # Batches on this page.
       sig do
         returns(
@@ -33,8 +38,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
@@ -54,6 +58,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           data: T::Array[ContextDev::Models::BatchListResponse::Data::OrHash],
           has_more: T::Boolean,
           key_metadata:
@@ -62,12 +67,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:,
         # Batches on this page.
         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
@@ -77,6 +84,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             data: T::Array[ContextDev::Models::BatchListResponse::Data],
             has_more: T::Boolean,
             key_metadata: ContextDev::Models::BatchListResponse::KeyMetadata,
@@ -693,25 +701,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

@@ -84,6 +84,11 @@ module ContextDev
       end
       attr_writer :progress
 
+      # 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
+
       # Download links, available once the batch reaches a final status and null before
       # then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
       sig do
@@ -137,6 +142,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,
@@ -152,6 +164,7 @@ module ContextDev
           mode: ContextDev::Models::BatchRetrieveResponse::Mode::OrSymbol,
           page_errors: T::Array[ContextDev::PageErrorCount::OrHash],
           progress: ContextDev::Models::BatchRetrieveResponse::Progress::OrHash,
+          request_id: String,
           results:
             T.nilable(
               ContextDev::Models::BatchRetrieveResponse::Results::OrHash
@@ -160,7 +173,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(
@@ -188,6 +202,9 @@ module ContextDev
         page_errors:,
         # Pages attempted so far. Use `status` to check completion.
         progress:,
+        # 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:,
         # Download links, available once the batch reaches a final status and null before
         # then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
         results:,
@@ -197,7 +214,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
 
@@ -216,13 +235,16 @@ module ContextDev
             mode: ContextDev::Models::BatchRetrieveResponse::Mode::TaggedSymbol,
             page_errors: T::Array[ContextDev::PageErrorCount],
             progress: ContextDev::Models::BatchRetrieveResponse::Progress,
+            request_id: String,
             results:
               T.nilable(ContextDev::Models::BatchRetrieveResponse::Results),
             status:
               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 +675,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 +690,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