context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/monitor_create_response.rbi

@@ -14,7 +14,8 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :id
 
-      # Discriminated union describing how changes are detected.
+      # How changes are judged. Defaults to `semantic` for extract targets and page
+      # targets with `instructions`, otherwise `exact`.
       sig do
         returns(
           ContextDev::Models::MonitorCreateResponse::ChangeDetection::Variants
@@ -25,14 +26,12 @@ module ContextDev
       sig { returns(Time) }
       attr_accessor :created_at
 
-      # The baseline run queued by this create call, or null if it could not be queued
-      # immediately (in which case the baseline runs on the next scheduled tick). Poll
-      # GET /monitors/{monitor_id}/runs/{run_id}.
+      # ID of the baseline run queued at creation; null if it will start on the next
+      # scheduled tick.
       sig { returns(T.nilable(String)) }
       attr_accessor :initial_run_id
 
-      # 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::MonitorCreateResponse::Mode::TaggedSymbol)
       end
@@ -41,30 +40,19 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :name
 
-      # Run the monitor on a fixed interval defined by a frequency and a unit, e.g.
-      # every 6 hours or every 2 days. The total interval (frequency × unit) must be
-      # between 10 minutes and 1 year.
-      sig { returns(ContextDev::Models::MonitorCreateResponse::Schedule) }
-      attr_reader :schedule
-
-      sig do
-        params(
-          schedule: ContextDev::Models::MonitorCreateResponse::Schedule::OrHash
-        ).void
-      end
-      attr_writer :schedule
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
+      sig { returns(String) }
+      attr_accessor :request_id
 
-      # Monitor lifecycle status. `failed` means the most recent run failed (see the
-      # monitor's `last_error`); failed monitors keep running on schedule and flip back
-      # to `active` on the next successful run. Monitors are auto-`paused` after
-      # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
-      # status to `active`.
+      # Current state. Failed monitors keep running; paused monitors must be resumed
+      # with `status: "active"`.
       sig do
         returns(ContextDev::Models::MonitorCreateResponse::Status::TaggedSymbol)
       end
       attr_accessor :status
 
-      # Discriminated union describing what the monitor watches.
+      # What to watch: a page, a sitemap, or data extracted from a site.
       sig do
         returns(ContextDev::Models::MonitorCreateResponse::Target::Variants)
       end
@@ -73,10 +61,8 @@ module ContextDev
       sig { returns(Time) }
       attr_accessor :updated_at
 
-      # Current baseline: the last observed value the monitor compares new snapshots
-      # against. Its shape follows `target.type` (page/sitemap/extract). Only populated
-      # on GET /monitors/{monitor_id}; null until the first baseline run completes (and
-      # after a target or change_detection update, which resets the baseline).
+      # Comparison baseline, included on Retrieve. Null until capture completes or after
+      # target changes.
       sig do
         returns(
           T.nilable(
@@ -86,6 +72,22 @@ module ContextDev
       end
       attr_accessor :baseline
 
+      # Credits this request used and your remaining balance.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::MonitorCreateResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::MonitorCreateResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig { returns(T.nilable(Time)) }
       attr_accessor :last_change_at
 
@@ -108,18 +110,33 @@ module ContextDev
       sig { returns(T.nilable(Time)) }
       attr_accessor :last_run_at
 
-      # When the next scheduled run is due.
+      # When the next scheduled run is due; null while paused.
       sig { returns(T.nilable(Time)) }
       attr_accessor :next_run_at
 
-      # User-defined tags for grouping and filtering monitors and their changes.
-      # Duplicates are removed.
+      # Run the monitor on a fixed interval defined by a frequency and a unit, e.g.
+      # every 6 hours or every 2 days. The total interval (frequency × unit) must be
+      # between 10 minutes and 1 year.
+      sig do
+        returns(T.nilable(ContextDev::Models::MonitorCreateResponse::Schedule))
+      end
+      attr_reader :schedule
+
+      sig do
+        params(
+          schedule: ContextDev::Models::MonitorCreateResponse::Schedule::OrHash
+        ).void
+      end
+      attr_writer :schedule
+
+      # Labels for filtering monitors, their changes, and their usage.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
+      # Webhook destination and delivery settings. Null means no webhook is configured.
       sig do
         returns(T.nilable(ContextDev::Models::MonitorCreateResponse::Webhook))
       end
@@ -155,8 +172,6 @@ module ContextDev
       end
       attr_writer :webhook_failure
 
-      # A newly created monitor plus `initial_run_id`, the id of the baseline run queued
-      # at creation.
       sig do
         params(
           id: String,
@@ -169,7 +184,7 @@ module ContextDev
           initial_run_id: T.nilable(String),
           mode: ContextDev::Models::MonitorCreateResponse::Mode::OrSymbol,
           name: String,
-          schedule: ContextDev::Models::MonitorCreateResponse::Schedule::OrHash,
+          request_id: String,
           status: ContextDev::Models::MonitorCreateResponse::Status::OrSymbol,
           target:
             T.any(
@@ -186,6 +201,8 @@ module ContextDev
                 ContextDev::Models::MonitorCreateResponse::Baseline::MonitorsExtractBaseline::OrHash
               )
             ),
+          key_metadata:
+            ContextDev::Models::MonitorCreateResponse::KeyMetadata::OrHash,
           last_change_at: T.nilable(Time),
           last_error:
             T.nilable(
@@ -193,6 +210,7 @@ module ContextDev
             ),
           last_run_at: T.nilable(Time),
           next_run_at: T.nilable(Time),
+          schedule: ContextDev::Models::MonitorCreateResponse::Schedule::OrHash,
           tags: T::Array[String],
           webhook:
             T.nilable(
@@ -206,44 +224,43 @@ module ContextDev
       end
       def self.new(
         id:,
-        # Discriminated union describing how changes are detected.
+        # How changes are judged. Defaults to `semantic` for extract targets and page
+        # targets with `instructions`, otherwise `exact`.
         change_detection:,
         created_at:,
-        # The baseline run queued by this create call, or null if it could not be queued
-        # immediately (in which case the baseline runs on the next scheduled tick). Poll
-        # GET /monitors/{monitor_id}/runs/{run_id}.
+        # ID of the baseline run queued at creation; null if it will start on the next
+        # scheduled tick.
         initial_run_id:,
-        # Top-level monitor category. Always `web` today; the concrete behavior is
-        # described by `target` and `change_detection`.
+        # Always `web`. Optional.
         mode:,
         name:,
-        # Run the monitor on a fixed interval defined by a frequency and a unit, e.g.
-        # every 6 hours or every 2 days. The total interval (frequency × unit) must be
-        # between 10 minutes and 1 year.
-        schedule:,
-        # Monitor lifecycle status. `failed` means the most recent run failed (see the
-        # monitor's `last_error`); failed monitors keep running on schedule and flip back
-        # to `active` on the next successful run. Monitors are auto-`paused` after
-        # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
-        # status to `active`.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
+        request_id:,
+        # Current state. Failed monitors keep running; paused monitors must be resumed
+        # with `status: "active"`.
         status:,
-        # Discriminated union describing what the monitor watches.
+        # What to watch: a page, a sitemap, or data extracted from a site.
         target:,
         updated_at:,
-        # Current baseline: the last observed value the monitor compares new snapshots
-        # against. Its shape follows `target.type` (page/sitemap/extract). Only populated
-        # on GET /monitors/{monitor_id}; null until the first baseline run completes (and
-        # after a target or change_detection update, which resets the baseline).
+        # Comparison baseline, included on Retrieve. Null until capture completes or after
+        # target changes.
         baseline: nil,
+        # Credits this request used and your remaining balance.
+        key_metadata: nil,
         last_change_at: nil,
         # Error from the most recent failed run; null when the last run succeeded.
         last_error: nil,
         last_run_at: nil,
-        # When the next scheduled run is due.
+        # When the next scheduled run is due; null while paused.
         next_run_at: nil,
-        # User-defined tags for grouping and filtering monitors and their changes.
-        # Duplicates are removed.
+        # Run the monitor on a fixed interval defined by a frequency and a unit, e.g.
+        # every 6 hours or every 2 days. The total interval (frequency × unit) must be
+        # between 10 minutes and 1 year.
+        schedule: nil,
+        # Labels for filtering monitors, their changes, and their usage.
         tags: nil,
+        # Webhook destination and delivery settings. Null means no webhook is configured.
         webhook: nil,
         # Present while webhook deliveries are failing consecutively; null when deliveries
         # are healthy or no webhook is configured. Cleared on the next successful delivery
@@ -262,7 +279,7 @@ module ContextDev
             initial_run_id: T.nilable(String),
             mode: ContextDev::Models::MonitorCreateResponse::Mode::TaggedSymbol,
             name: String,
-            schedule: ContextDev::Models::MonitorCreateResponse::Schedule,
+            request_id: String,
             status:
               ContextDev::Models::MonitorCreateResponse::Status::TaggedSymbol,
             target: ContextDev::Models::MonitorCreateResponse::Target::Variants,
@@ -271,11 +288,14 @@ module ContextDev
               T.nilable(
                 ContextDev::Models::MonitorCreateResponse::Baseline::Variants
               ),
+            key_metadata:
+              ContextDev::Models::MonitorCreateResponse::KeyMetadata,
             last_change_at: T.nilable(Time),
             last_error:
               T.nilable(ContextDev::Models::MonitorCreateResponse::LastError),
             last_run_at: T.nilable(Time),
             next_run_at: T.nilable(Time),
+            schedule: ContextDev::Models::MonitorCreateResponse::Schedule,
             tags: T::Array[String],
             webhook:
               T.nilable(ContextDev::Models::MonitorCreateResponse::Webhook),
@@ -289,7 +309,8 @@ module ContextDev
       def to_hash
       end
 
-      # Discriminated union describing how changes are detected.
+      # How changes are judged. Defaults to `semantic` for extract targets and page
+      # targets with `instructions`, otherwise `exact`.
       module ChangeDetection
         extend ContextDev::Internal::Type::Union
 
@@ -310,13 +331,17 @@ module ContextDev
               )
             end
 
+          # Use `exact` to compare visible text or sitemap URLs.
           sig { returns(Symbol) }
           attr_accessor :type
 
           # Detect exact changes. For page targets, this means visible text diffs. For
           # sitemap targets, this means URL additions and removals.
           sig { params(type: Symbol).returns(T.attached_class) }
-          def self.new(type: :exact)
+          def self.new(
+            # Use `exact` to compare visible text or sitemap URLs.
+            type: :exact
+          )
           end
 
           sig { override.returns({ type: Symbol }) }
@@ -333,25 +358,30 @@ module ContextDev
               )
             end
 
+          # Use `semantic` to judge changes against the target instructions.
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Minimum confidence required to report a meaningful change, from 0 to 1.
           sig { returns(T.nilable(Float)) }
           attr_reader :confidence_threshold
 
           sig { params(confidence_threshold: Float).void }
           attr_writer :confidence_threshold
 
-          # Detect meaning-level changes to page content, ignoring cosmetic or
-          # instruction-irrelevant differences. Which changes are meaningful is judged
-          # against the page or extract target's `instructions` (and an extract target's
-          # `schema`, when provided).
+          # Detect meaningful content changes using the target’s instructions and optional
+          # schema.
           sig do
             params(confidence_threshold: Float, type: Symbol).returns(
               T.attached_class
             )
           end
-          def self.new(confidence_threshold: nil, type: :semantic)
+          def self.new(
+            # Minimum confidence required to report a meaningful change, from 0 to 1.
+            confidence_threshold: nil,
+            # Use `semantic` to judge changes against the target instructions.
+            type: :semantic
+          )
           end
 
           sig do
@@ -372,8 +402,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
 
@@ -400,145 +429,8 @@ module ContextDev
         end
       end
 
-      class Schedule < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::Models::MonitorCreateResponse::Schedule,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Number of units between runs. The resulting interval (frequency × unit) must be
-        # at least 10 minutes and at most 1 year (e.g. minimum 10 when unit is minutes;
-        # maximum 365 when unit is days).
-        sig { returns(Integer) }
-        attr_accessor :frequency
-
-        sig do
-          returns(
-            ContextDev::Models::MonitorCreateResponse::Schedule::Type::TaggedSymbol
-          )
-        end
-        attr_accessor :type
-
-        sig do
-          returns(
-            ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
-          )
-        end
-        attr_accessor :unit
-
-        # Run the monitor on a fixed interval defined by a frequency and a unit, e.g.
-        # every 6 hours or every 2 days. The total interval (frequency × unit) must be
-        # between 10 minutes and 1 year.
-        sig do
-          params(
-            frequency: Integer,
-            type:
-              ContextDev::Models::MonitorCreateResponse::Schedule::Type::OrSymbol,
-            unit:
-              ContextDev::Models::MonitorCreateResponse::Schedule::Unit::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Number of units between runs. The resulting interval (frequency × unit) must be
-          # at least 10 minutes and at most 1 year (e.g. minimum 10 when unit is minutes;
-          # maximum 365 when unit is days).
-          frequency:,
-          type:,
-          unit:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              frequency: Integer,
-              type:
-                ContextDev::Models::MonitorCreateResponse::Schedule::Type::TaggedSymbol,
-              unit:
-                ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module Type
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::Models::MonitorCreateResponse::Schedule::Type
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          INTERVAL =
-            T.let(
-              :interval,
-              ContextDev::Models::MonitorCreateResponse::Schedule::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::Models::MonitorCreateResponse::Schedule::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        module Unit
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::Models::MonitorCreateResponse::Schedule::Unit
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          MINUTES =
-            T.let(
-              :minutes,
-              ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
-            )
-          HOURS =
-            T.let(
-              :hours,
-              ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
-            )
-          DAYS =
-            T.let(
-              :days,
-              ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
-      # Monitor lifecycle status. `failed` means the most recent run failed (see the
-      # monitor's `last_error`); failed monitors keep running on schedule and flip back
-      # to `active` on the next successful run. Monitors are auto-`paused` after
-      # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
-      # status to `active`.
+      # Current state. Failed monitors keep running; paused monitors must be resumed
+      # with `status: "active"`.
       module Status
         extend ContextDev::Internal::Type::Enum
 
@@ -575,7 +467,7 @@ module ContextDev
         end
       end
 
-      # Discriminated union describing what the monitor watches.
+      # What to watch: a page, a sitemap, or data extracted from a site.
       module Target
         extend ContextDev::Internal::Type::Union
 
@@ -597,27 +489,37 @@ module ContextDev
               )
             end
 
+          # Use `page` to watch one web page.
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Public HTTP(S) page URL to monitor.
           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.
+          # Optional browser actions executed in array order after the page loads, before
+          # content is captured, on every run. Requires a paid plan. Maximum: 5 actions.
+          # Changes create a new baseline.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Variants
+                ]
+              )
+            )
+          end
+          attr_accessor :actions
+
+          # Remove matching regions after inclusions. Changes create 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.
+          # Monitor these CSS-selected regions. Empty or omitted uses main content. Changes
+          # create a new baseline.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :include_selectors
 
@@ -644,6 +546,16 @@ module ContextDev
           sig do
             params(
               url: String,
+              actions:
+                T.nilable(
+                  T::Array[
+                    T.any(
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Wait::OrHash,
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Perform::OrHash,
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::OrHash
+                    )
+                  ]
+                ),
               exclude_selectors: T::Array[String],
               include_selectors: T::Array[String],
               instructions: String,
@@ -652,23 +564,23 @@ module ContextDev
             ).returns(T.attached_class)
           end
           def self.new(
+            # Public HTTP(S) page URL to monitor.
             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.
+            # Optional browser actions executed in array order after the page loads, before
+            # content is captured, on every run. Requires a paid plan. Maximum: 5 actions.
+            # Changes create a new baseline.
+            actions: nil,
+            # Remove matching regions after inclusions. Changes create 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.
+            # Monitor these CSS-selected regions. Empty or omitted uses main content. Changes
+            # create 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,
             # Normalize whitespace before comparing or analyzing text.
             normalize_whitespace: nil,
+            # Use `page` to watch one web page.
             type: :page
           )
           end
@@ -678,6 +590,12 @@ module ContextDev
               {
                 type: Symbol,
                 url: String,
+                actions:
+                  T.nilable(
+                    T::Array[
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Variants
+                    ]
+                  ),
                 exclude_selectors: T::Array[String],
                 include_selectors: T::Array[String],
                 instructions: String,
@@ -687,6 +605,305 @@ module ContextDev
           end
           def to_hash
           end
+
+          # Browser action discriminated by `do`. Each variant exposes only its applicable
+          # fields.
+          module Action
+            extend ContextDev::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Wait,
+                  ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Perform,
+                  ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll
+                )
+              end
+
+            class Wait < ContextDev::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Wait,
+                    ContextDev::Internal::AnyHash
+                  )
+                end
+
+              # Use `wait` to pause for a fixed duration.
+              sig { returns(Symbol) }
+              attr_accessor :do_
+
+              # Time to pause in milliseconds before the next action.
+              sig { returns(Integer) }
+              attr_accessor :time_ms
+
+              # Pause for a fixed number of milliseconds before continuing to the next action.
+              sig do
+                params(time_ms: Integer, do_: Symbol).returns(T.attached_class)
+              end
+              def self.new(
+                # Time to pause in milliseconds before the next action.
+                time_ms:,
+                # Use `wait` to pause for a fixed duration.
+                do_: :wait
+              )
+              end
+
+              sig { override.returns({ do_: Symbol, time_ms: Integer }) }
+              def to_hash
+              end
+            end
+
+            class Perform < ContextDev::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Perform,
+                    ContextDev::Internal::AnyHash
+                  )
+                end
+
+              # One browser instruction, such as clicking a button or entering text.
+              sig { returns(String) }
+              attr_accessor :action
+
+              # Use `perform` for a plain-language browser instruction.
+              sig { returns(Symbol) }
+              attr_accessor :do_
+
+              # Resolve and perform one natural-language browser action.
+              sig do
+                params(action: String, do_: Symbol).returns(T.attached_class)
+              end
+              def self.new(
+                # One browser instruction, such as clicking a button or entering text.
+                action:,
+                # Use `perform` for a plain-language browser instruction.
+                do_: :perform
+              )
+              end
+
+              sig { override.returns({ action: String, do_: Symbol }) }
+              def to_hash
+              end
+            end
+
+            class Scroll < ContextDev::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll,
+                    ContextDev::Internal::AnyHash
+                  )
+                end
+
+              # Use `scroll` to move through the page or a container.
+              sig { returns(Symbol) }
+              attr_accessor :do_
+
+              # Pixels per scroll, one visible viewport, or the current scroll boundary.
+              # Defaults to viewport.
+              sig do
+                returns(
+                  T.nilable(
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount::Variants
+                  )
+                )
+              end
+              attr_reader :amount
+
+              sig do
+                params(
+                  amount:
+                    T.any(
+                      Integer,
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount::OrSymbol
+                    )
+                ).void
+              end
+              attr_writer :amount
+
+              # CSS selector for the first matching scroll container. Defaults to the page.
+              sig { returns(T.nilable(String)) }
+              attr_reader :container
+
+              sig { params(container: String).void }
+              attr_writer :container
+
+              # Direction to scroll. Defaults to down.
+              sig do
+                returns(
+                  T.nilable(
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::TaggedSymbol
+                  )
+                )
+              end
+              attr_reader :direction
+
+              sig do
+                params(
+                  direction:
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::OrSymbol
+                ).void
+              end
+              attr_writer :direction
+
+              # Maximum scroll iterations. Stops early when scrolling and scrollable extent stop
+              # changing. Defaults to 1.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :max_scrolls
+
+              sig { params(max_scrolls: Integer).void }
+              attr_writer :max_scrolls
+
+              # Scroll the page or a selected scrollable container, waiting adaptively for
+              # content and dimensions to settle after each iteration.
+              sig do
+                params(
+                  amount:
+                    T.any(
+                      Integer,
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount::OrSymbol
+                    ),
+                  container: String,
+                  direction:
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::OrSymbol,
+                  max_scrolls: Integer,
+                  do_: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Pixels per scroll, one visible viewport, or the current scroll boundary.
+                # Defaults to viewport.
+                amount: nil,
+                # CSS selector for the first matching scroll container. Defaults to the page.
+                container: nil,
+                # Direction to scroll. Defaults to down.
+                direction: nil,
+                # Maximum scroll iterations. Stops early when scrolling and scrollable extent stop
+                # changing. Defaults to 1.
+                max_scrolls: nil,
+                # Use `scroll` to move through the page or a container.
+                do_: :scroll
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    do_: Symbol,
+                    amount:
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount::Variants,
+                    container: String,
+                    direction:
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::TaggedSymbol,
+                    max_scrolls: Integer
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Pixels per scroll, one visible viewport, or the current scroll boundary.
+              # Defaults to viewport.
+              module Amount
+                extend ContextDev::Internal::Type::Union
+
+                Variants =
+                  T.type_alias do
+                    T.any(
+                      Integer,
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount::TaggedSymbol
+                    )
+                  end
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount::Variants
+                    ]
+                  )
+                end
+                def self.variants
+                end
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                VIEWPORT =
+                  T.let(
+                    :viewport,
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount::TaggedSymbol
+                  )
+                MAX =
+                  T.let(
+                    :max,
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Amount::TaggedSymbol
+                  )
+              end
+
+              # Direction to scroll. Defaults to down.
+              module Direction
+                extend ContextDev::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                UP =
+                  T.let(
+                    :up,
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::TaggedSymbol
+                  )
+                DOWN =
+                  T.let(
+                    :down,
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::TaggedSymbol
+                  )
+                LEFT =
+                  T.let(
+                    :left,
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::TaggedSymbol
+                  )
+                RIGHT =
+                  T.let(
+                    :right,
+                    ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Scroll::Direction::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  ContextDev::Models::MonitorCreateResponse::Target::Page::Action::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
         end
 
         class Sitemap < ContextDev::Internal::Type::BaseModel
@@ -698,6 +915,7 @@ module ContextDev
               )
             end
 
+          # Use `sitemap` to watch a site for added or removed URLs.
           sig { returns(Symbol) }
           attr_accessor :type
 
@@ -726,11 +944,7 @@ module ContextDev
           sig { params(max_urls: Integer).void }
           attr_writer :max_urls
 
-          # Watch a sitemap for URL additions and removals. Crawled URLs are normalized
-          # (lowercased host, no trailing slash/fragment) and scoped to the monitored site
-          # and its subdomains before comparison. On a detected difference the sitemap is
-          # re-fetched within the same run and only URLs both observations agree on are
-          # reported, suppressing transient crawl flaps.
+          # Watch a site’s URL inventory for confirmed additions and removals.
           sig do
             params(
               url: String,
@@ -749,6 +963,7 @@ module ContextDev
             include: nil,
             # Maximum number of sitemap URLs to track (capped at 10,000).
             max_urls: nil,
+            # Use `sitemap` to watch a site for added or removed URLs.
             type: :sitemap
           )
           end
@@ -782,6 +997,7 @@ module ContextDev
           sig { returns(String) }
           attr_accessor :instructions
 
+          # Use `extract` to watch structured data across selected pages.
           sig { returns(Symbol) }
           attr_accessor :type
 
@@ -789,6 +1005,7 @@ module ContextDev
           sig { returns(String) }
           attr_accessor :url
 
+          # Allow page discovery on subdomains of the target site.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :follow_subdomains
 
@@ -809,25 +1026,16 @@ module ContextDev
           sig { params(max_pages: Integer).void }
           attr_writer :max_pages
 
-          # JSON Schema describing the data you care about. It is used three ways: it guides
-          # which pages are selected for tracking, it gives the change judge extra context
-          # on which changes matter (alongside `instructions`), and it defines the shape of
-          # the baseline `data` snapshot on GET /monitors/{monitor_id} (refreshed at most
-          # about once a day). It is not a response format for changes: change events and
-          # webhook payloads always contain diffs, summaries, and evidence excerpts — never
-          # data in this schema's shape. If omitted, a default summary + key-points schema
-          # is used.
+          # JSON Schema for page selection and the baseline snapshot. Changes return diffs
+          # and evidence.
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_reader :schema
 
           sig { params(schema: T::Hash[Symbol, T.anything]).void }
           attr_writer :schema
 
-          # Watch the monitor-relevant pages of a site for meaningful changes. A crawl
-          # guided by `schema`/`instructions` selects up to `max_pages` relevant pages to
-          # track; each run re-checks exactly those pages, and confirmed content changes are
-          # judged for relevance against the monitor's `instructions` (and `schema`, when
-          # provided). The tracked page set is refreshed by a periodic re-discovery crawl.
+          # Track relevant pages selected by `schema` and `instructions`; refresh the page
+          # set periodically.
           sig do
             params(
               instructions: String,
@@ -845,20 +1053,16 @@ module ContextDev
             instructions:,
             # Root URL to extract structured data from.
             url:,
+            # Allow page discovery on subdomains of the target site.
             follow_subdomains: nil,
             # Optional maximum link depth from the starting URL (0 = only the starting page).
             max_depth: nil,
             # Maximum number of pages to track.
             max_pages: nil,
-            # JSON Schema describing the data you care about. It is used three ways: it guides
-            # which pages are selected for tracking, it gives the change judge extra context
-            # on which changes matter (alongside `instructions`), and it defines the shape of
-            # the baseline `data` snapshot on GET /monitors/{monitor_id} (refreshed at most
-            # about once a day). It is not a response format for changes: change events and
-            # webhook payloads always contain diffs, summaries, and evidence excerpts — never
-            # data in this schema's shape. If omitted, a default summary + key-points schema
-            # is used.
+            # JSON Schema for page selection and the baseline snapshot. Changes return diffs
+            # and evidence.
             schema: nil,
+            # Use `extract` to watch structured data across selected pages.
             type: :extract
           )
           end
@@ -891,10 +1095,8 @@ module ContextDev
         end
       end
 
-      # Current baseline: the last observed value the monitor compares new snapshots
-      # against. Its shape follows `target.type` (page/sitemap/extract). Only populated
-      # on GET /monitors/{monitor_id}; null until the first baseline run completes (and
-      # after a target or change_detection update, which resets the baseline).
+      # Comparison baseline, included on Retrieve. Null until capture completes or after
+      # target changes.
       module Baseline
         extend ContextDev::Internal::Type::Union
 
@@ -1003,10 +1205,8 @@ module ContextDev
           sig { returns(Time) }
           attr_accessor :captured_at
 
-          # The extracted structured data, matching the monitor's extraction schema (same
-          # shape as the /web/extract endpoint's `data`). Refreshed when the monitor
-          # re-discovers its page set (at most about once a day); `null` when no extraction
-          # has been captured yet.
+          # Latest structured snapshot matching the extraction schema, refreshed at most
+          # daily; `null` before capture.
           sig { returns(T.anything) }
           attr_accessor :data
 
@@ -1026,10 +1226,8 @@ module ContextDev
           def self.new(
             # When this baseline was last captured or replaced.
             captured_at:,
-            # The extracted structured data, matching the monitor's extraction schema (same
-            # shape as the /web/extract endpoint's `data`). Refreshed when the monitor
-            # re-discovers its page set (at most about once a day); `null` when no extraction
-            # has been captured yet.
+            # Latest structured snapshot matching the extraction schema, refreshed at most
+            # daily; `null` before capture.
             data:,
             # The page URLs the monitor tracks and analyzes for changes.
             urls_analyzed:
@@ -1060,6 +1258,46 @@ module ContextDev
         end
       end
 
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorCreateResponse::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
+
       class LastError < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1085,6 +1323,146 @@ module ContextDev
         end
       end
 
+      class Schedule < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorCreateResponse::Schedule,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Number of units between runs. The resulting interval (frequency × unit) must be
+        # at least 10 minutes and at most 1 year (e.g. minimum 10 when unit is minutes;
+        # maximum 365 when unit is days).
+        sig { returns(Integer) }
+        attr_accessor :frequency
+
+        # Use `interval` to run on a repeating schedule.
+        sig do
+          returns(
+            ContextDev::Models::MonitorCreateResponse::Schedule::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Time unit used with `frequency` to set the run interval.
+        sig do
+          returns(
+            ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
+          )
+        end
+        attr_accessor :unit
+
+        # Run the monitor on a fixed interval defined by a frequency and a unit, e.g.
+        # every 6 hours or every 2 days. The total interval (frequency × unit) must be
+        # between 10 minutes and 1 year.
+        sig do
+          params(
+            frequency: Integer,
+            type:
+              ContextDev::Models::MonitorCreateResponse::Schedule::Type::OrSymbol,
+            unit:
+              ContextDev::Models::MonitorCreateResponse::Schedule::Unit::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Number of units between runs. The resulting interval (frequency × unit) must be
+          # at least 10 minutes and at most 1 year (e.g. minimum 10 when unit is minutes;
+          # maximum 365 when unit is days).
+          frequency:,
+          # Use `interval` to run on a repeating schedule.
+          type:,
+          # Time unit used with `frequency` to set the run interval.
+          unit:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              frequency: Integer,
+              type:
+                ContextDev::Models::MonitorCreateResponse::Schedule::Type::TaggedSymbol,
+              unit:
+                ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Use `interval` to run on a repeating schedule.
+        module Type
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::MonitorCreateResponse::Schedule::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INTERVAL =
+            T.let(
+              :interval,
+              ContextDev::Models::MonitorCreateResponse::Schedule::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::MonitorCreateResponse::Schedule::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Time unit used with `frequency` to set the run interval.
+        module Unit
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::MonitorCreateResponse::Schedule::Unit
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MINUTES =
+            T.let(
+              :minutes,
+              ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
+            )
+          HOURS =
+            T.let(
+              :hours,
+              ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
+            )
+          DAYS =
+            T.let(
+              :days,
+              ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::MonitorCreateResponse::Schedule::Unit::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class Webhook < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1094,15 +1472,13 @@ module ContextDev
             )
           end
 
-        # Webhook URL events are delivered to. Slack incoming webhook URLs are
-        # automatically formatted as Slack messages.
+        # Public HTTP(S) URL that receives events. Slack and GovSlack URLs get formatted
+        # messages.
         sig { returns(String) }
         attr_accessor :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
-        # that detected no change — and embeds the change when one was detected. Defaults
-        # to `["change.detected"]` when omitted.
+        # Events to deliver. Defaults to `change.detected`; `run.completed` also includes
+        # unchanged runs.
         sig do
           returns(
             T.nilable(
@@ -1131,18 +1507,15 @@ module ContextDev
         sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
         attr_writer :retry_
 
-        # 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;
-        # cannot be set by clients.
+        # API-generated signing secret. Visible only with full access or `monitors:write`
+        # permission.
         sig { returns(T.nilable(String)) }
         attr_reader :secret
 
         sig { params(secret: String).void }
         attr_writer :secret
 
+        # Webhook destination and delivery settings. Null means no webhook is configured.
         sig do
           params(
             url: String,
@@ -1155,22 +1528,16 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
-          # Webhook URL events are delivered to. Slack incoming webhook URLs are
-          # automatically formatted as Slack messages.
+          # Public HTTP(S) URL that receives events. Slack and GovSlack URLs get formatted
+          # 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
-          # that detected no change — and embeds the change when one was detected. Defaults
-          # to `["change.detected"]` when omitted.
+          # Events to deliver. Defaults to `change.detected`; `run.completed` also includes
+          # unchanged runs.
           events: nil,
           # Webhook retry settings. Use {} for the default schedule.
           retry_: nil,
-          # 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;
-          # cannot be set by clients.
+          # API-generated signing secret. Visible only with full access or `monitors:write`
+          # permission.
           secret: nil
         )
         end