context.dev 2.14.0 → 2.16.0

data/rbi/context_dev/models/web_web_scrape_images_response.rbi

@@ -33,6 +33,11 @@ module ContextDev
       end
       attr_accessor :images
 
+      # 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 true on success.
       sig do
         returns(
@@ -67,8 +72,7 @@ module ContextDev
       end
       attr_writer :actions_applied
 
-      # 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::WebWebScrapeImagesResponse::KeyMetadata)
@@ -92,6 +96,7 @@ module ContextDev
             T::Array[
               ContextDev::Models::WebWebScrapeImagesResponse::Image::OrHash
             ],
+          request_id: String,
           success:
             ContextDev::Models::WebWebScrapeImagesResponse::Success::OrBoolean,
           url: String,
@@ -110,14 +115,16 @@ module ContextDev
         cache_metadata:,
         # Images found on the page.
         images:,
+        # 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 true on success.
         success:,
         # Page URL that was scraped.
         url:,
         # One verified outcome per requested browser action, in request order.
         actions_applied: 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
@@ -129,6 +136,7 @@ module ContextDev
               ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata,
             images:
               T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image],
+            request_id: String,
             success:
               ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean,
             url: String,
@@ -781,25 +789,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/web_web_scrape_md_params.rbi

@@ -129,9 +129,8 @@ module ContextDev
       sig { params(shorten_base64_images: T::Boolean).void }
       attr_writer :shorten_base64_images
 
-      # 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
 
@@ -156,7 +155,9 @@ module ContextDev
       attr_writer :use_main_content_only
 
       # Optional browser wait time in milliseconds after initial page load before
-      # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds).
+      # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
+      # with timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter
+      # deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :wait_for_ms
 
@@ -251,9 +252,8 @@ module ContextDev
         settle_animations: nil,
         # Shorten base64-encoded image data in the Markdown output
         shorten_base64_images: 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
@@ -263,7 +263,9 @@ module ContextDev
         # and navigation
         use_main_content_only: nil,
         # Optional browser wait time in milliseconds after initial page load before
-        # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds).
+        # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
+        # with timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter
+        # deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
         wait_for_ms: 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

data/rbi/context_dev/models/web_web_scrape_md_response.rbi

@@ -46,6 +46,11 @@ module ContextDev
       end
       attr_writer :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
+
       # Indicates success
       sig do
         returns(
@@ -95,8 +100,7 @@ module ContextDev
       sig { params(html: String).void }
       attr_writer :html
 
-      # 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::WebWebScrapeMdResponse::KeyMetadata)
@@ -120,6 +124,7 @@ module ContextDev
           markdown: String,
           metadata:
             ContextDev::Models::WebWebScrapeMdResponse::Metadata::OrHash,
+          request_id: String,
           success:
             ContextDev::Models::WebWebScrapeMdResponse::Success::OrBoolean,
           url: String,
@@ -146,6 +151,9 @@ module ContextDev
         markdown:,
         # Metadata extracted from the scraped page HTML.
         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:,
         # Indicates success
         success:,
         # The URL that was scraped
@@ -159,8 +167,7 @@ module ContextDev
         # from — the same body the Scrape HTML endpoint returns for the equivalent
         # request.
         html: 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
@@ -173,6 +180,7 @@ module ContextDev
             content_length: Integer,
             markdown: String,
             metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata,
+            request_id: String,
             success:
               ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean,
             url: String,
@@ -984,25 +992,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/web_web_scrape_sitemap_params.rbi

@@ -60,9 +60,8 @@ module ContextDev
       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.
+      # 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
 
@@ -135,9 +134,8 @@ module ContextDev
         # 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.
+        # 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/web_web_scrape_sitemap_response.rbi

@@ -26,6 +26,11 @@ module ContextDev
       end
       attr_writer :meta
 
+      # 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
+
       # Indicates success
       sig do
         returns(
@@ -39,8 +44,7 @@ module ContextDev
       sig { returns(T::Array[String]) }
       attr_accessor :urls
 
-      # 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(
@@ -62,6 +66,7 @@ module ContextDev
         params(
           domain: String,
           meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash,
+          request_id: String,
           success:
             ContextDev::Models::WebWebScrapeSitemapResponse::Success::OrBoolean,
           urls: T::Array[String],
@@ -74,13 +79,15 @@ module ContextDev
         domain:,
         # Metadata about the sitemap crawl operation
         meta:,
+        # 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:,
         # Indicates success
         success:,
         # Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set
         # these are only the matching pages, most relevant first.
         urls:,
-        # 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
@@ -90,6 +97,7 @@ module ContextDev
           {
             domain: String,
             meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta,
+            request_id: String,
             success:
               ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean,
             urls: T::Array[String],
@@ -200,25 +208,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/webhook_delivery.rbi

@@ -41,6 +41,13 @@ module ContextDev
       sig { returns(ContextDev::WebhookDelivery::Status::TaggedSymbol) }
       attr_accessor :status
 
+      # Delivery ID for status checks and retries, when available.
+      sig { returns(T.nilable(String)) }
+      attr_reader :delivery_id
+
+      sig { params(delivery_id: String).void }
+      attr_writer :delivery_id
+
       sig do
         params(
           attempted_at: Time,
@@ -48,7 +55,8 @@ module ContextDev
           event: ContextDev::WebhookDelivery::Event::OrSymbol,
           event_id: String,
           http_status: T.nilable(Integer),
-          status: ContextDev::WebhookDelivery::Status::OrSymbol
+          status: ContextDev::WebhookDelivery::Status::OrSymbol,
+          delivery_id: String
         ).returns(T.attached_class)
       end
       def self.new(
@@ -65,7 +73,9 @@ module ContextDev
         # Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
         # response; failed means no HTTP response was received; skipped_unsafe_url means
         # the URL failed the public-endpoint safety check.
-        status:
+        status:,
+        # Delivery ID for status checks and retries, when available.
+        delivery_id: nil
       )
       end
 
@@ -77,7 +87,8 @@ module ContextDev
             event: ContextDev::WebhookDelivery::Event::TaggedSymbol,
             event_id: String,
             http_status: T.nilable(Integer),
-            status: ContextDev::WebhookDelivery::Status::TaggedSymbol
+            status: ContextDev::WebhookDelivery::Status::TaggedSymbol,
+            delivery_id: String
           }
         )
       end

data/rbi/context_dev/models/webhooks/attempt.rbi

@@ -0,0 +1,160 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    module Webhooks
+      class Attempt < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ContextDev::Webhooks::Attempt, ContextDev::Internal::AnyHash)
+          end
+
+        # Attempt number, starting at 1.
+        sig { returns(Integer) }
+        attr_accessor :attempt
+
+        # Completion time, or null while in progress.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :completed_at
+
+        # Attempt error, or null if none.
+        sig { returns(T.nilable(ContextDev::Webhooks::Attempt::Error)) }
+        attr_reader :error
+
+        sig do
+          params(
+            error: T.nilable(ContextDev::Webhooks::Attempt::Error::OrHash)
+          ).void
+        end
+        attr_writer :error
+
+        # HTTP response status, or null if no response was received.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :http_status
+
+        # Attempt start time.
+        sig { returns(Time) }
+        attr_accessor :started_at
+
+        # What started this attempt.
+        sig { returns(ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol) }
+        attr_accessor :trigger
+
+        # URL used for this attempt.
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig do
+          params(
+            attempt: Integer,
+            completed_at: T.nilable(Time),
+            error: T.nilable(ContextDev::Webhooks::Attempt::Error::OrHash),
+            http_status: T.nilable(Integer),
+            started_at: Time,
+            trigger: ContextDev::Webhooks::Attempt::Trigger::OrSymbol,
+            url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Attempt number, starting at 1.
+          attempt:,
+          # Completion time, or null while in progress.
+          completed_at:,
+          # Attempt error, or null if none.
+          error:,
+          # HTTP response status, or null if no response was received.
+          http_status:,
+          # Attempt start time.
+          started_at:,
+          # What started this attempt.
+          trigger:,
+          # URL used for this attempt.
+          url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              attempt: Integer,
+              completed_at: T.nilable(Time),
+              error: T.nilable(ContextDev::Webhooks::Attempt::Error),
+              http_status: T.nilable(Integer),
+              started_at: Time,
+              trigger: ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol,
+              url: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Error < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Webhooks::Attempt::Error,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Error code.
+          sig { returns(String) }
+          attr_accessor :code
+
+          # Error details.
+          sig { returns(String) }
+          attr_accessor :message
+
+          # Attempt error, or null if none.
+          sig do
+            params(code: String, message: String).returns(T.attached_class)
+          end
+          def self.new(
+            # Error code.
+            code:,
+            # Error details.
+            message:
+          )
+          end
+
+          sig { override.returns({ code: String, message: String }) }
+          def to_hash
+          end
+        end
+
+        # What started this attempt.
+        module Trigger
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ContextDev::Webhooks::Attempt::Trigger)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INITIAL =
+            T.let(
+              :initial,
+              ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol
+            )
+          AUTOMATIC =
+            T.let(
+              :automatic,
+              ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol
+            )
+          MANUAL =
+            T.let(:manual, ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end