context.dev 2.13.0 → 2.15.0

data/rbi/context_dev/models/web_web_scrape_html_response.rbi

@@ -98,8 +98,7 @@ module ContextDev
       sig { params(actions_html_stale: T::Boolean).void }
       attr_writer :actions_html_stale
 
-      # Metadata about the API key used for the request. Included in every response
-      # whenever a valid API key is provided, even when the response status is not 200.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata)
@@ -160,8 +159,7 @@ module ContextDev
         # True when an action was applied but the returned content could not be refreshed
         # afterward.
         actions_html_stale: nil,
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil
       )
       end
@@ -1080,25 +1078,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_images_params.rbi

@@ -75,9 +75,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
 
@@ -144,9 +143,8 @@ module ContextDev
         # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
         # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
         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 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_images_response.rbi

@@ -67,8 +67,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)
@@ -116,8 +115,7 @@ module ContextDev
         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
@@ -781,25 +779,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
 
@@ -251,9 +250,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

data/rbi/context_dev/models/web_web_scrape_md_response.rbi

@@ -95,8 +95,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)
@@ -159,8 +158,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
@@ -984,25 +982,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

@@ -27,6 +27,14 @@ module ContextDev
       sig { params(headers: T::Hash[Symbol, String]).void }
       attr_writer :headers
 
+      # When true, discover and include public pages and sitemaps on subdomains of the
+      # requested domain. Defaults to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_subdomains
+
+      sig { params(include_subdomains: T::Boolean).void }
+      attr_writer :include_subdomains
+
       # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
       # Minimum is 1, maximum is 100,000.
       sig { returns(T.nilable(Integer)) }
@@ -52,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
 
@@ -96,6 +103,7 @@ module ContextDev
         params(
           domain: String,
           headers: T::Hash[Symbol, String],
+          include_subdomains: T::Boolean,
           max_links: Integer,
           search: String,
           sitemap_url: String,
@@ -113,6 +121,9 @@ module ContextDev
         # deep-object query params such as headers[X-Custom]=value. When provided, caching
         # is bypassed: the result is neither read from nor written to cache.
         headers: nil,
+        # When true, discover and include public pages and sitemaps on subdomains of the
+        # requested domain. Defaults to false.
+        include_subdomains: nil,
         # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
         # Minimum is 1, maximum is 100,000.
         max_links: nil,
@@ -123,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
@@ -148,6 +158,7 @@ module ContextDev
           {
             domain: String,
             headers: T::Hash[Symbol, String],
+            include_subdomains: T::Boolean,
             max_links: Integer,
             search: String,
             sitemap_url: String,

data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi

@@ -39,8 +39,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(
@@ -79,8 +78,7 @@ module ContextDev
         # 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
@@ -200,25 +198,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