context.dev 2.15.0 → 2.17.0

data/rbi/context_dev/models/log_retrieve_response.rbi

@@ -0,0 +1,370 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class LogRetrieveResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::LogRetrieveResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(ContextDev::Models::LogRetrieveResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: ContextDev::Models::LogRetrieveResponse::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # 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::LogRetrieveResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::LogRetrieveResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig do
+        params(
+          data: ContextDev::Models::LogRetrieveResponse::Data::OrHash,
+          request_id: String,
+          key_metadata:
+            ContextDev::Models::LogRetrieveResponse::KeyMetadata::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # 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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: ContextDev::Models::LogRetrieveResponse::Data,
+            request_id: String,
+            key_metadata: ContextDev::Models::LogRetrieveResponse::KeyMetadata
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::LogRetrieveResponse::Data,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits charged for this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_used
+
+        # The `error_code` from the response, or null on success.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :error_code
+
+        # What was sent with the request.
+        sig { returns(ContextDev::Models::LogRetrieveResponse::Data::Input) }
+        attr_reader :input
+
+        sig do
+          params(
+            input: ContextDev::Models::LogRetrieveResponse::Data::Input::OrHash
+          ).void
+        end
+        attr_writer :input
+
+        # ID of the API key that made the request.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :key_id
+
+        # Server-side processing time in milliseconds.
+        sig { returns(Float) }
+        attr_accessor :latency_ms
+
+        # HTTP method.
+        sig { returns(String) }
+        attr_accessor :method_
+
+        # Endpoint path as called.
+        sig { returns(String) }
+        attr_accessor :path
+
+        # Request ID of the logged API call.
+        sig { returns(String) }
+        attr_accessor :request_id
+
+        # HTTP status code returned.
+        sig { returns(Integer) }
+        attr_accessor :status_code
+
+        # Request tags supplied by the caller.
+        sig { returns(T::Array[String]) }
+        attr_accessor :tags
+
+        # When the request completed.
+        sig { returns(Time) }
+        attr_accessor :timestamp
+
+        # User-Agent header of the request.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :user_agent
+
+        # Whether the request was made under zero data retention.
+        sig { returns(T::Boolean) }
+        attr_accessor :zdr
+
+        # Credit usage, included whenever a valid API key is provided.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata
+            )
+          )
+        end
+        attr_reader :key_metadata
+
+        sig do
+          params(
+            key_metadata:
+              ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata::OrHash
+          ).void
+        end
+        attr_writer :key_metadata
+
+        # The retained JSON response with credentials redacted, or null when unavailable.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :response
+
+        sig { params(response: T.anything).void }
+        attr_writer :response
+
+        sig do
+          params(
+            credits_used: Integer,
+            error_code: T.nilable(String),
+            input: ContextDev::Models::LogRetrieveResponse::Data::Input::OrHash,
+            key_id: T.nilable(String),
+            latency_ms: Float,
+            method_: String,
+            path: String,
+            request_id: String,
+            status_code: Integer,
+            tags: T::Array[String],
+            timestamp: Time,
+            user_agent: T.nilable(String),
+            zdr: T::Boolean,
+            key_metadata:
+              ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata::OrHash,
+            response: T.anything
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Credits charged for this request.
+          credits_used:,
+          # The `error_code` from the response, or null on success.
+          error_code:,
+          # What was sent with the request.
+          input:,
+          # ID of the API key that made the request.
+          key_id:,
+          # Server-side processing time in milliseconds.
+          latency_ms:,
+          # HTTP method.
+          method_:,
+          # Endpoint path as called.
+          path:,
+          # Request ID of the logged API call.
+          request_id:,
+          # HTTP status code returned.
+          status_code:,
+          # Request tags supplied by the caller.
+          tags:,
+          # When the request completed.
+          timestamp:,
+          # User-Agent header of the request.
+          user_agent:,
+          # Whether the request was made under zero data retention.
+          zdr:,
+          # Credit usage, included whenever a valid API key is provided.
+          key_metadata: nil,
+          # The retained JSON response with credentials redacted, or null when unavailable.
+          response: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              credits_used: Integer,
+              error_code: T.nilable(String),
+              input: ContextDev::Models::LogRetrieveResponse::Data::Input,
+              key_id: T.nilable(String),
+              latency_ms: Float,
+              method_: String,
+              path: String,
+              request_id: String,
+              status_code: Integer,
+              tags: T::Array[String],
+              timestamp: Time,
+              user_agent: T.nilable(String),
+              zdr: T::Boolean,
+              key_metadata:
+                ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata,
+              response: T.anything
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Input < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::LogRetrieveResponse::Data::Input,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Query parameters as sent.
+          sig { returns(T::Hash[Symbol, T.anything]) }
+          attr_accessor :query
+
+          # Request body with credentials and uploaded content redacted.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :body
+
+          sig { params(body: T.anything).void }
+          attr_writer :body
+
+          # What was sent with the request.
+          sig do
+            params(
+              query: T::Hash[Symbol, T.anything],
+              body: T.anything
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Query parameters as sent.
+            query:,
+            # Request body with credentials and uploaded content redacted.
+            body: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { query: T::Hash[Symbol, T.anything], body: T.anything }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class KeyMetadata < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Credits used by this request.
+          sig { returns(Integer) }
+          attr_accessor :credits_consumed
+
+          # Credits remaining for your organization.
+          sig { returns(Integer) }
+          attr_accessor :credits_remaining
+
+          # 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(
+            # Credits used by this request.
+            credits_consumed:,
+            # Credits remaining for your organization.
+            credits_remaining:
+          )
+          end
+
+          sig do
+            override.returns(
+              { credits_consumed: Integer, credits_remaining: Integer }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::LogRetrieveResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits used by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # Credits remaining for your organization.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # 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(
+          # Credits used by this request.
+          credits_consumed:,
+          # Credits remaining for your organization.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/monitor_create_params.rbi

@@ -185,6 +185,27 @@ module ContextDev
           sig { returns(String) }
           attr_accessor :url
 
+          # CSS selectors for HTML regions to remove before text extraction. Applied after
+          # include_selectors; exclusion takes precedence when an element matches both. Omit
+          # or pass an empty array to apply no explicit exclusions. Changing these selectors
+          # creates a new baseline.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :exclude_selectors
+
+          sig { params(exclude_selectors: T::Array[String]).void }
+          attr_writer :exclude_selectors
+
+          # CSS selectors defining the HTML regions to monitor. Matching subtrees are
+          # combined in document order before text extraction, instead of automatic
+          # main-content selection. Omit or pass an empty array to use automatic
+          # main-content extraction. If the filtered page has no usable text, the run fails
+          # without replacing the baseline. Changing these selectors creates a new baseline.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :include_selectors
+
+          sig { params(include_selectors: T::Array[String]).void }
+          attr_writer :include_selectors
+
           # Plain-language goal describing which page changes matter. When provided without
           # change_detection, semantic detection is inferred.
           sig { returns(T.nilable(String)) }
@@ -205,6 +226,8 @@ module ContextDev
           sig do
             params(
               url: String,
+              exclude_selectors: T::Array[String],
+              include_selectors: T::Array[String],
               instructions: String,
               normalize_whitespace: T::Boolean,
               type: Symbol
@@ -212,6 +235,17 @@ module ContextDev
           end
           def self.new(
             url:,
+            # CSS selectors for HTML regions to remove before text extraction. Applied after
+            # include_selectors; exclusion takes precedence when an element matches both. Omit
+            # or pass an empty array to apply no explicit exclusions. Changing these selectors
+            # creates a new baseline.
+            exclude_selectors: nil,
+            # CSS selectors defining the HTML regions to monitor. Matching subtrees are
+            # combined in document order before text extraction, instead of automatic
+            # main-content selection. Omit or pass an empty array to use automatic
+            # main-content extraction. If the filtered page has no usable text, the run fails
+            # without replacing the baseline. Changing these selectors creates a new baseline.
+            include_selectors: nil,
             # Plain-language goal describing which page changes matter. When provided without
             # change_detection, semantic detection is inferred.
             instructions: nil,
@@ -226,6 +260,8 @@ module ContextDev
               {
                 type: Symbol,
                 url: String,
+                exclude_selectors: T::Array[String],
+                include_selectors: T::Array[String],
                 instructions: String,
                 normalize_whitespace: T::Boolean
               }
@@ -665,7 +701,8 @@ module ContextDev
             )
           end
 
-        # Webhook URL events are delivered to.
+        # Webhook URL events are delivered to. Slack incoming webhook URLs are
+        # automatically formatted as Slack messages.
         sig { returns(String) }
         attr_accessor :url
 
@@ -712,7 +749,8 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
-          # Webhook URL events are delivered to.
+          # Webhook URL events are delivered to. Slack incoming webhook URLs are
+          # automatically formatted as Slack messages.
           url:,
           # Events delivered to this endpoint. `change.detected` fires only when a run
           # detects a change; `run.completed` fires on every completed run — including runs

data/rbi/context_dev/models/monitor_create_response.rbi

@@ -603,6 +603,27 @@ module ContextDev
           sig { returns(String) }
           attr_accessor :url
 
+          # CSS selectors for HTML regions to remove before text extraction. Applied after
+          # include_selectors; exclusion takes precedence when an element matches both. Omit
+          # or pass an empty array to apply no explicit exclusions. Changing these selectors
+          # creates a new baseline.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :exclude_selectors
+
+          sig { params(exclude_selectors: T::Array[String]).void }
+          attr_writer :exclude_selectors
+
+          # CSS selectors defining the HTML regions to monitor. Matching subtrees are
+          # combined in document order before text extraction, instead of automatic
+          # main-content selection. Omit or pass an empty array to use automatic
+          # main-content extraction. If the filtered page has no usable text, the run fails
+          # without replacing the baseline. Changing these selectors creates a new baseline.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :include_selectors
+
+          sig { params(include_selectors: T::Array[String]).void }
+          attr_writer :include_selectors
+
           # Plain-language goal describing which page changes matter. When provided without
           # change_detection, semantic detection is inferred.
           sig { returns(T.nilable(String)) }
@@ -623,6 +644,8 @@ module ContextDev
           sig do
             params(
               url: String,
+              exclude_selectors: T::Array[String],
+              include_selectors: T::Array[String],
               instructions: String,
               normalize_whitespace: T::Boolean,
               type: Symbol
@@ -630,6 +653,17 @@ module ContextDev
           end
           def self.new(
             url:,
+            # CSS selectors for HTML regions to remove before text extraction. Applied after
+            # include_selectors; exclusion takes precedence when an element matches both. Omit
+            # or pass an empty array to apply no explicit exclusions. Changing these selectors
+            # creates a new baseline.
+            exclude_selectors: nil,
+            # CSS selectors defining the HTML regions to monitor. Matching subtrees are
+            # combined in document order before text extraction, instead of automatic
+            # main-content selection. Omit or pass an empty array to use automatic
+            # main-content extraction. If the filtered page has no usable text, the run fails
+            # without replacing the baseline. Changing these selectors creates a new baseline.
+            include_selectors: nil,
             # Plain-language goal describing which page changes matter. When provided without
             # change_detection, semantic detection is inferred.
             instructions: nil,
@@ -644,6 +678,8 @@ module ContextDev
               {
                 type: Symbol,
                 url: String,
+                exclude_selectors: T::Array[String],
+                include_selectors: T::Array[String],
                 instructions: String,
                 normalize_whitespace: T::Boolean
               }
@@ -1058,7 +1094,8 @@ module ContextDev
             )
           end
 
-        # Webhook URL events are delivered to.
+        # Webhook URL events are delivered to. Slack incoming webhook URLs are
+        # automatically formatted as Slack messages.
         sig { returns(String) }
         attr_accessor :url
 
@@ -1094,7 +1131,8 @@ module ContextDev
         sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
         attr_writer :retry_
 
-        # Signing secret used to verify webhook authenticity. Each delivery includes an
+        # Signing secret used to verify webhook authenticity. Omitted unless the API key
+        # has monitors:write permission or full access. Each delivery includes an
         # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
         # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
         # compare and reject stale timestamps to prevent replay. Generated by the API;
@@ -1117,7 +1155,8 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
-          # Webhook URL events are delivered to.
+          # Webhook URL events are delivered to. Slack incoming webhook URLs are
+          # automatically formatted as Slack messages.
           url:,
           # Events delivered to this endpoint. `change.detected` fires only when a run
           # detects a change; `run.completed` fires on every completed run — including runs
@@ -1126,7 +1165,8 @@ module ContextDev
           events: nil,
           # Webhook retry settings. Use {} for the default schedule.
           retry_: nil,
-          # Signing secret used to verify webhook authenticity. Each delivery includes an
+          # Signing secret used to verify webhook authenticity. Omitted unless the API key
+          # has monitors:write permission or full access. Each delivery includes an
           # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
           # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
           # compare and reject stale timestamps to prevent replay. Generated by the API;

data/rbi/context_dev/models/monitor_list_response.rbi

@@ -655,6 +655,27 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :url
 
+            # CSS selectors for HTML regions to remove before text extraction. Applied after
+            # include_selectors; exclusion takes precedence when an element matches both. Omit
+            # or pass an empty array to apply no explicit exclusions. Changing these selectors
+            # creates a new baseline.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :exclude_selectors
+
+            sig { params(exclude_selectors: T::Array[String]).void }
+            attr_writer :exclude_selectors
+
+            # CSS selectors defining the HTML regions to monitor. Matching subtrees are
+            # combined in document order before text extraction, instead of automatic
+            # main-content selection. Omit or pass an empty array to use automatic
+            # main-content extraction. If the filtered page has no usable text, the run fails
+            # without replacing the baseline. Changing these selectors creates a new baseline.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :include_selectors
+
+            sig { params(include_selectors: T::Array[String]).void }
+            attr_writer :include_selectors
+
             # Plain-language goal describing which page changes matter. When provided without
             # change_detection, semantic detection is inferred.
             sig { returns(T.nilable(String)) }
@@ -675,6 +696,8 @@ module ContextDev
             sig do
               params(
                 url: String,
+                exclude_selectors: T::Array[String],
+                include_selectors: T::Array[String],
                 instructions: String,
                 normalize_whitespace: T::Boolean,
                 type: Symbol
@@ -682,6 +705,17 @@ module ContextDev
             end
             def self.new(
               url:,
+              # CSS selectors for HTML regions to remove before text extraction. Applied after
+              # include_selectors; exclusion takes precedence when an element matches both. Omit
+              # or pass an empty array to apply no explicit exclusions. Changing these selectors
+              # creates a new baseline.
+              exclude_selectors: nil,
+              # CSS selectors defining the HTML regions to monitor. Matching subtrees are
+              # combined in document order before text extraction, instead of automatic
+              # main-content selection. Omit or pass an empty array to use automatic
+              # main-content extraction. If the filtered page has no usable text, the run fails
+              # without replacing the baseline. Changing these selectors creates a new baseline.
+              include_selectors: nil,
               # Plain-language goal describing which page changes matter. When provided without
               # change_detection, semantic detection is inferred.
               instructions: nil,
@@ -696,6 +730,8 @@ module ContextDev
                 {
                   type: Symbol,
                   url: String,
+                  exclude_selectors: T::Array[String],
+                  include_selectors: T::Array[String],
                   instructions: String,
                   normalize_whitespace: T::Boolean
                 }
@@ -1116,7 +1152,8 @@ module ContextDev
               )
             end
 
-          # Webhook URL events are delivered to.
+          # Webhook URL events are delivered to. Slack incoming webhook URLs are
+          # automatically formatted as Slack messages.
           sig { returns(String) }
           attr_accessor :url
 
@@ -1152,7 +1189,8 @@ module ContextDev
           sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
           attr_writer :retry_
 
-          # Signing secret used to verify webhook authenticity. Each delivery includes an
+          # Signing secret used to verify webhook authenticity. Omitted unless the API key
+          # has monitors:write permission or full access. Each delivery includes an
           # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
           # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
           # compare and reject stale timestamps to prevent replay. Generated by the API;
@@ -1175,7 +1213,8 @@ module ContextDev
             ).returns(T.attached_class)
           end
           def self.new(
-            # Webhook URL events are delivered to.
+            # Webhook URL events are delivered to. Slack incoming webhook URLs are
+            # automatically formatted as Slack messages.
             url:,
             # Events delivered to this endpoint. `change.detected` fires only when a run
             # detects a change; `run.completed` fires on every completed run — including runs
@@ -1184,7 +1223,8 @@ module ContextDev
             events: nil,
             # Webhook retry settings. Use {} for the default schedule.
             retry_: nil,
-            # Signing secret used to verify webhook authenticity. Each delivery includes an
+            # Signing secret used to verify webhook authenticity. Omitted unless the API key
+            # has monitors:write permission or full access. Each delivery includes an
             # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
             # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
             # compare and reject stale timestamps to prevent replay. Generated by the API;