context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/monitor_list_runs_params.rbi

@@ -14,6 +14,7 @@ module ContextDev
           )
         end
 
+      # ID of the monitor.
       sig { returns(String) }
       attr_accessor :monitor_id
 
@@ -52,6 +53,7 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # ID of the monitor.
         monitor_id:,
         # Opaque pagination cursor from a previous response.
         cursor: nil,

data/rbi/context_dev/models/monitor_list_runs_response.rbi

@@ -22,15 +22,48 @@ module ContextDev
       sig { returns(T.nilable(String)) }
       attr_accessor :next_cursor
 
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
+      sig { returns(String) }
+      attr_accessor :request_id
+
+      # Credits this request used and your remaining balance.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::MonitorListRunsResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::MonitorListRunsResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           data:
             T::Array[ContextDev::Models::MonitorListRunsResponse::Data::OrHash],
           has_more: T::Boolean,
-          next_cursor: T.nilable(String)
+          next_cursor: T.nilable(String),
+          request_id: String,
+          key_metadata:
+            ContextDev::Models::MonitorListRunsResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(data:, has_more:, next_cursor:)
+      def self.new(
+        data:,
+        has_more:,
+        next_cursor:,
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
+        request_id:,
+        # Credits this request used and your remaining balance.
+        key_metadata: nil
+      )
       end
 
       sig do
@@ -38,7 +71,10 @@ module ContextDev
           {
             data: T::Array[ContextDev::Models::MonitorListRunsResponse::Data],
             has_more: T::Boolean,
-            next_cursor: T.nilable(String)
+            next_cursor: T.nilable(String),
+            request_id: String,
+            key_metadata:
+              ContextDev::Models::MonitorListRunsResponse::KeyMetadata
           }
         )
       end
@@ -79,7 +115,7 @@ module ContextDev
         sig { returns(String) }
         attr_accessor :monitor_id
 
-        # The first run after monitor creation is a baseline run.
+        # A baseline run follows creation or a target or detection change.
         sig do
           returns(
             ContextDev::Models::MonitorListRunsResponse::Data::RunType::TaggedSymbol
@@ -152,9 +188,7 @@ module ContextDev
         end
         attr_writer :webhook_deliveries
 
-        # Deprecated: use `webhook_deliveries`, which records every attempt now that a run
-        # can deliver multiple events. Omitted when no webhook was attempted, including
-        # historical runs created before delivery tracking was added.
+        # Deprecated. Use `webhook_deliveries` for all attempts.
         sig { returns(T.nilable(ContextDev::WebhookDelivery)) }
         attr_reader :webhook_delivery
 
@@ -211,7 +245,7 @@ module ContextDev
           # Credits charged for this run (0 for skipped/failed runs).
           credits_charged:,
           monitor_id:,
-          # The first run after monitor creation is a baseline run.
+          # A baseline run follows creation or a target or detection change.
           run_type:,
           # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
           # (insufficient credits, monitor paused, or superseded by a concurrent run).
@@ -227,9 +261,7 @@ module ContextDev
           # fired. Omitted when no webhook was attempted, including runs created before
           # event selection was added.
           webhook_deliveries: nil,
-          # Deprecated: use `webhook_deliveries`, which records every attempt now that a run
-          # can deliver multiple events. Omitted when no webhook was attempted, including
-          # historical runs created before delivery tracking was added.
+          # Deprecated. Use `webhook_deliveries` for all attempts.
           webhook_delivery: nil,
           # Webhook delivery IDs for this run.
           webhook_delivery_ids: nil
@@ -306,7 +338,7 @@ module ContextDev
           end
         end
 
-        # The first run after monitor creation is a baseline run.
+        # A baseline run follows creation or a target or detection change.
         module RunType
           extend ContextDev::Internal::Type::Enum
 
@@ -497,6 +529,46 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorListRunsResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits charged for this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # Credits remaining for your organization.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Credits this request used and your remaining balance.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Credits charged for 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_retrieve_change_params.rbi

@@ -14,6 +14,7 @@ module ContextDev
           )
         end
 
+      # ID of the detected change.
       sig { returns(String) }
       attr_accessor :change_id
 
@@ -23,7 +24,11 @@ module ContextDev
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(change_id:, request_options: {})
+      def self.new(
+        # ID of the detected change.
+        change_id:,
+        request_options: {}
+      )
       end
 
       sig do

data/rbi/context_dev/models/monitor_retrieve_change_response.rbi

@@ -24,8 +24,7 @@ module ContextDev
       sig { returns(Time) }
       attr_accessor :detected_at
 
-      # Top-level monitor category. Always `web` today; the concrete behavior is
-      # described by `target` and `change_detection`.
+      # Always `web`. Optional.
       sig do
         returns(
           ContextDev::Models::MonitorRetrieveChangeResponse::Mode::TaggedSymbol
@@ -36,6 +35,11 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :monitor_id
 
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # The run that detected this change.
       sig { returns(String) }
       attr_accessor :run_id
@@ -43,8 +47,7 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :summary
 
-      # User-defined tags for grouping and filtering monitors and their changes.
-      # Duplicates are removed.
+      # Labels for filtering monitors, their changes, and their usage.
       sig { returns(T::Array[String]) }
       attr_accessor :tags
 
@@ -137,6 +140,24 @@ module ContextDev
       end
       attr_writer :importance
 
+      # Credits this request used and your remaining balance.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::MonitorRetrieveChangeResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::MonitorRetrieveChangeResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig { returns(T.nilable(Integer)) }
       attr_reader :matched_url_count
 
@@ -163,11 +184,6 @@ module ContextDev
       sig { params(removed_urls: T::Array[String]).void }
       attr_writer :removed_urls
 
-      # A detected change. `mode` is the constant `web`; `target_type` and
-      # `change_detection_type` describe the change, and which optional fields are
-      # present depends on them (page: `diff` + excerpts; sitemap:
-      # `added_urls`/`removed_urls`; semantic:
-      # `confidence`/`importance`/`evidence`/`matched_urls`).
       sig do
         params(
           id: String,
@@ -177,6 +193,7 @@ module ContextDev
           mode:
             ContextDev::Models::MonitorRetrieveChangeResponse::Mode::OrSymbol,
           monitor_id: String,
+          request_id: String,
           run_id: String,
           summary: String,
           tags: T::Array[String],
@@ -196,6 +213,8 @@ module ContextDev
             ],
           importance:
             ContextDev::Models::MonitorRetrieveChangeResponse::Importance::OrSymbol,
+          key_metadata:
+            ContextDev::Models::MonitorRetrieveChangeResponse::KeyMetadata::OrHash,
           matched_url_count: Integer,
           matched_urls: T::Array[String],
           removed_url_count: Integer,
@@ -206,15 +225,16 @@ module ContextDev
         id:,
         change_detection_type:,
         detected_at:,
-        # Top-level monitor category. Always `web` today; the concrete behavior is
-        # described by `target` and `change_detection`.
+        # Always `web`. Optional.
         mode:,
         monitor_id:,
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
+        request_id:,
         # The run that detected this change.
         run_id:,
         summary:,
-        # User-defined tags for grouping and filtering monitors and their changes.
-        # Duplicates are removed.
+        # Labels for filtering monitors, their changes, and their usage.
         tags:,
         target_type:,
         title:,
@@ -229,6 +249,8 @@ module ContextDev
         diff: nil,
         evidence: nil,
         importance: nil,
+        # Credits this request used and your remaining balance.
+        key_metadata: nil,
         matched_url_count: nil,
         # At most 500 URLs are included; the corresponding count field is always exact.
         matched_urls: nil,
@@ -248,6 +270,7 @@ module ContextDev
             mode:
               ContextDev::Models::MonitorRetrieveChangeResponse::Mode::TaggedSymbol,
             monitor_id: String,
+            request_id: String,
             run_id: String,
             summary: String,
             tags: T::Array[String],
@@ -267,6 +290,8 @@ module ContextDev
               ],
             importance:
               ContextDev::Models::MonitorRetrieveChangeResponse::Importance::TaggedSymbol,
+            key_metadata:
+              ContextDev::Models::MonitorRetrieveChangeResponse::KeyMetadata,
             matched_url_count: Integer,
             matched_urls: T::Array[String],
             removed_url_count: Integer,
@@ -311,8 +336,7 @@ module ContextDev
         end
       end
 
-      # Top-level monitor category. Always `web` today; the concrete behavior is
-      # described by `target` and `change_detection`.
+      # Always `web`. Optional.
       module Mode
         extend ContextDev::Internal::Type::Enum
 
@@ -463,6 +487,46 @@ module ContextDev
         def self.values
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorRetrieveChangeResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits charged for this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # Credits remaining for your organization.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Credits this request used and your remaining balance.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Credits charged for 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_retrieve_params.rbi

@@ -14,6 +14,7 @@ module ContextDev
           )
         end
 
+      # ID of the monitor.
       sig { returns(String) }
       attr_accessor :monitor_id
 
@@ -23,7 +24,11 @@ module ContextDev
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(monitor_id:, request_options: {})
+      def self.new(
+        # ID of the monitor.
+        monitor_id:,
+        request_options: {}
+      )
       end
 
       sig do