context.dev 2.21.0 → 2.22.0

data/lib/context_dev/models/monitor_list_changes_response.rb

@@ -20,10 +20,32 @@ module ContextDev
       #   @return [String, nil]
       required :next_cursor, String, nil?: true
 
-      # @!method initialize(data:, has_more:, next_cursor:)
+      # @!attribute request_id
+      #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      #   support.
+      #
+      #   @return [String]
+      required :request_id, String
+
+      # @!attribute key_metadata
+      #   Credits this request used and your remaining balance.
+      #
+      #   @return [ContextDev::Models::MonitorListChangesResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::MonitorListChangesResponse::KeyMetadata }
+
+      # @!method initialize(data:, has_more:, next_cursor:, request_id:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::MonitorListChangesResponse} for more details.
+      #
       #   @param data [Array<ContextDev::Models::MonitorListChangesResponse::Data>]
+      #
       #   @param has_more [Boolean]
+      #
       #   @param next_cursor [String, nil]
+      #
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
+      #
+      #   @param key_metadata [ContextDev::Models::MonitorListChangesResponse::KeyMetadata] Credits this request used and your remaining balance.
 
       class Data < ContextDev::Internal::Type::BaseModel
         # @!attribute id
@@ -43,8 +65,7 @@ module ContextDev
         required :detected_at, Time
 
         # @!attribute mode
-        #   Top-level monitor category. Always `web` today; the concrete behavior is
-        #   described by `target` and `change_detection`.
+        #   Always `web`. Optional.
         #
         #   @return [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::Mode]
         required :mode, enum: -> { ContextDev::Models::MonitorListChangesResponse::Data::Mode }
@@ -54,11 +75,23 @@ module ContextDev
         #   @return [String]
         required :monitor_id, String
 
+        # @!attribute run_id
+        #   The run that detected this change.
+        #
+        #   @return [String]
+        required :run_id, String
+
         # @!attribute summary
         #
         #   @return [String]
         required :summary, String
 
+        # @!attribute tags
+        #   Labels for filtering monitors, their changes, and their usage.
+        #
+        #   @return [Array<String>]
+        required :tags, ContextDev::Internal::Type::ArrayOf[String]
+
         # @!attribute target_type
         #
         #   @return [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::TargetType]
@@ -79,11 +112,39 @@ module ContextDev
         #   @return [Integer, nil]
         optional :added_url_count, Integer
 
+        # @!attribute added_urls
+        #   At most 500 URLs are included; the corresponding count field is always exact.
+        #
+        #   @return [Array<String>, nil]
+        optional :added_urls, ContextDev::Internal::Type::ArrayOf[String]
+
+        # @!attribute after_text_excerpt
+        #
+        #   @return [String, nil]
+        optional :after_text_excerpt, String
+
+        # @!attribute before_text_excerpt
+        #
+        #   @return [String, nil]
+        optional :before_text_excerpt, String
+
         # @!attribute confidence
         #
         #   @return [Float, nil]
         optional :confidence, Float
 
+        # @!attribute diff
+        #   Text diff between the previous and current page baseline (page targets).
+        #
+        #   @return [String, nil]
+        optional :diff, String
+
+        # @!attribute evidence
+        #
+        #   @return [Array<ContextDev::Models::MonitorListChangesResponse::Data::Evidence>, nil]
+        optional :evidence,
+                 -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorListChangesResponse::Data::Evidence] }
+
         # @!attribute importance
         #
         #   @return [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::Importance, nil]
@@ -94,27 +155,25 @@ module ContextDev
         #   @return [Integer, nil]
         optional :matched_url_count, Integer
 
+        # @!attribute matched_urls
+        #   At most 500 URLs are included; the corresponding count field is always exact.
+        #
+        #   @return [Array<String>, nil]
+        optional :matched_urls, ContextDev::Internal::Type::ArrayOf[String]
+
         # @!attribute removed_url_count
         #
         #   @return [Integer, nil]
         optional :removed_url_count, Integer
 
-        # @!attribute tags
-        #   User-defined tags for grouping and filtering monitors and their changes.
-        #   Duplicates are removed.
+        # @!attribute removed_urls
+        #   At most 500 URLs are included; the corresponding count field is always exact.
         #
         #   @return [Array<String>, nil]
-        optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+        optional :removed_urls, ContextDev::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(id:, change_detection_type:, detected_at:, mode:, monitor_id:, summary:, target_type:, title:, url:, added_url_count: nil, confidence: nil, importance: nil, matched_url_count: nil, removed_url_count: nil, tags: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::MonitorListChangesResponse::Data} for more details.
-        #
-        #   A lightweight change summary. `mode` is the constant `web`; `target_type` and
-        #   `change_detection_type` describe the change, and which optional fields are
-        #   present depends on them (e.g. sitemap changes include
-        #   `added_url_count`/`removed_url_count`; semantic changes include
-        #   `confidence`/`importance`).
+        # @!method initialize(id:, change_detection_type:, detected_at:, mode:, monitor_id:, run_id:, summary:, tags:, target_type:, title:, url:, added_url_count: nil, added_urls: nil, after_text_excerpt: nil, before_text_excerpt: nil, confidence: nil, diff: nil, evidence: nil, importance: nil, matched_url_count: nil, matched_urls: nil, removed_url_count: nil, removed_urls: nil)
+        #   Detected change, including applicable diffs, URLs, and supporting evidence.
         #
         #   @param id [String]
         #
@@ -122,12 +181,16 @@ module ContextDev
         #
         #   @param detected_at [Time]
         #
-        #   @param mode [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::Mode] Top-level monitor category. Always `web` today; the concrete behavior is describ
+        #   @param mode [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::Mode] Always `web`. Optional.
         #
         #   @param monitor_id [String]
         #
+        #   @param run_id [String] The run that detected this change.
+        #
         #   @param summary [String]
         #
+        #   @param tags [Array<String>] Labels for filtering monitors, their changes, and their usage.
+        #
         #   @param target_type [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::TargetType]
         #
         #   @param title [String]
@@ -136,15 +199,27 @@ module ContextDev
         #
         #   @param added_url_count [Integer]
         #
+        #   @param added_urls [Array<String>] At most 500 URLs are included; the corresponding count field is always exact.
+        #
+        #   @param after_text_excerpt [String]
+        #
+        #   @param before_text_excerpt [String]
+        #
         #   @param confidence [Float]
         #
+        #   @param diff [String] Text diff between the previous and current page baseline (page targets).
+        #
+        #   @param evidence [Array<ContextDev::Models::MonitorListChangesResponse::Data::Evidence>]
+        #
         #   @param importance [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::Importance]
         #
         #   @param matched_url_count [Integer]
         #
+        #   @param matched_urls [Array<String>] At most 500 URLs are included; the corresponding count field is always exact.
+        #
         #   @param removed_url_count [Integer]
         #
-        #   @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
+        #   @param removed_urls [Array<String>] At most 500 URLs are included; the corresponding count field is always exact.
 
         # @see ContextDev::Models::MonitorListChangesResponse::Data#change_detection_type
         module ChangeDetectionType
@@ -157,8 +232,7 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
 
-        # Top-level monitor category. Always `web` today; the concrete behavior is
-        # described by `target` and `change_detection`.
+        # Always `web`. Optional.
         #
         # @see ContextDev::Models::MonitorListChangesResponse::Data#mode
         module Mode
@@ -182,6 +256,33 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
 
+        class Evidence < ContextDev::Internal::Type::BaseModel
+          # @!attribute after
+          #   Snapshot of the content after the change.
+          #
+          #   @return [String]
+          required :after, String
+
+          # @!attribute before
+          #   Snapshot of the content before the change.
+          #
+          #   @return [String]
+          required :before, String
+
+          # @!attribute url
+          #   Optional URL the evidence relates to. Absent for whole-target diffs.
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(after:, before:, url: nil)
+          #   @param after [String] Snapshot of the content after the change.
+          #
+          #   @param before [String] Snapshot of the content before the change.
+          #
+          #   @param url [String] Optional URL the evidence relates to. Absent for whole-target diffs.
+        end
+
         # @see ContextDev::Models::MonitorListChangesResponse::Data#importance
         module Importance
           extend ContextDev::Internal::Type::Enum
@@ -194,6 +295,28 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
       end
+
+      # @see ContextDev::Models::MonitorListChangesResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   Credits charged for this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   Credits remaining for your organization.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, credits_remaining:)
+        #   Credits this request used and your remaining balance.
+        #
+        #   @param credits_consumed [Integer] Credits charged for this request.
+        #
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
+      end
     end
   end
 end

data/lib/context_dev/models/monitor_list_params.rb

@@ -32,8 +32,8 @@ module ContextDev
       optional :q, String
 
       # @!attribute search_by
-      #   Comma-separated fields to search with `q`. Defaults to all of them. Note
-      #   `instructions` only exists on extract monitors.
+      #   Fields to search with `q`. Defaults to all fields; page and extract targets can
+      #   have instructions.
       #
       #   @return [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil]
       optional :search_by,
@@ -83,7 +83,7 @@ module ContextDev
       #
       #   @param q [String] Free-text search term, matched against the fields named in `search_by`.
       #
-      #   @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil] Comma-separated fields to search with `q`. Defaults to all of them. Note `instru
+      #   @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil] Fields to search with `q`. Defaults to all fields; page and extract targets can
       #
       #   @param search_type [Symbol, ContextDev::Models::MonitorListParams::SearchType] `prefix` for as-you-type prefix matching (default), `exact` for full-token match
       #