context.dev 1.35.0 → 2.0.0

data/lib/context_dev/models/monitor_list_runs_response.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Monitors#list_runs
+    class MonitorListRunsResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<ContextDev::Models::MonitorListRunsResponse::Data>]
+      required :data,
+               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorListRunsResponse::Data] }
+
+      # @!attribute has_more
+      #
+      #   @return [Boolean]
+      required :has_more, ContextDev::Internal::Type::Boolean
+
+      # @!attribute next_cursor
+      #
+      #   @return [String, nil]
+      required :next_cursor, String, nil?: true
+
+      # @!method initialize(data:, has_more:, next_cursor:)
+      #   @param data [Array<ContextDev::Models::MonitorListRunsResponse::Data>]
+      #   @param has_more [Boolean]
+      #   @param next_cursor [String, nil]
+
+      class Data < ContextDev::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute baseline_created
+        #   True when this run established the monitor's initial baseline; baseline runs
+        #   perform no change detection.
+        #
+        #   @return [Boolean]
+        required :baseline_created, ContextDev::Internal::Type::Boolean
+
+        # @!attribute change_detected
+        #
+        #   @return [Boolean]
+        required :change_detected, ContextDev::Internal::Type::Boolean
+
+        # @!attribute change_detection_type
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::ChangeDetectionType]
+        required :change_detection_type,
+                 enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::ChangeDetectionType }
+
+        # @!attribute credits_charged
+        #   Credits charged for this run (0 for skipped/failed runs).
+        #
+        #   @return [Integer]
+        required :credits_charged, Integer
+
+        # @!attribute monitor_id
+        #
+        #   @return [String]
+        required :monitor_id, String
+
+        # @!attribute run_type
+        #   The first run after monitor creation is a baseline run.
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::RunType]
+        required :run_type, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::RunType }
+
+        # @!attribute status
+        #   Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
+        #   (insufficient credits, monitor paused, or superseded by a concurrent run).
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::Status]
+        required :status, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::Status }
+
+        # @!attribute target_type
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::TargetType]
+        required :target_type, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::TargetType }
+
+        # @!attribute change_id
+        #
+        #   @return [String, nil]
+        optional :change_id, String, nil?: true
+
+        # @!attribute completed_at
+        #
+        #   @return [Time, nil]
+        optional :completed_at, Time, nil?: true
+
+        # @!attribute error
+        #
+        #   @return [ContextDev::Models::MonitorListRunsResponse::Data::Error, nil]
+        optional :error, -> { ContextDev::Models::MonitorListRunsResponse::Data::Error }, nil?: true
+
+        # @!attribute skip_reason
+        #   Why a skipped run never executed; null unless status is `skipped`.
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::SkipReason, nil]
+        optional :skip_reason,
+                 enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::SkipReason },
+                 nil?: true
+
+        # @!attribute started_at
+        #
+        #   @return [Time, nil]
+        optional :started_at, Time, nil?: true
+
+        # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::MonitorListRunsResponse::Data} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param baseline_created [Boolean] True when this run established the monitor's initial baseline; baseline runs per
+        #
+        #   @param change_detected [Boolean]
+        #
+        #   @param change_detection_type [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::ChangeDetectionType]
+        #
+        #   @param credits_charged [Integer] Credits charged for this run (0 for skipped/failed runs).
+        #
+        #   @param monitor_id [String]
+        #
+        #   @param run_type [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::RunType] The first run after monitor creation is a baseline run.
+        #
+        #   @param status [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::Status] Lifecycle status of a run. `skipped` runs never executed — see `skip_reason` (in
+        #
+        #   @param target_type [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::TargetType]
+        #
+        #   @param change_id [String, nil]
+        #
+        #   @param completed_at [Time, nil]
+        #
+        #   @param error [ContextDev::Models::MonitorListRunsResponse::Data::Error, nil]
+        #
+        #   @param skip_reason [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::SkipReason, nil] Why a skipped run never executed; null unless status is `skipped`.
+        #
+        #   @param started_at [Time, nil]
+
+        # @see ContextDev::Models::MonitorListRunsResponse::Data#change_detection_type
+        module ChangeDetectionType
+          extend ContextDev::Internal::Type::Enum
+
+          EXACT = :exact
+          SEMANTIC = :semantic
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The first run after monitor creation is a baseline run.
+        #
+        # @see ContextDev::Models::MonitorListRunsResponse::Data#run_type
+        module RunType
+          extend ContextDev::Internal::Type::Enum
+
+          BASELINE = :baseline
+          SCHEDULED = :scheduled
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
+        # (insufficient credits, monitor paused, or superseded by a concurrent run).
+        #
+        # @see ContextDev::Models::MonitorListRunsResponse::Data#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          QUEUED = :queued
+          RUNNING = :running
+          COMPLETED = :completed
+          FAILED = :failed
+          SKIPPED = :skipped
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see ContextDev::Models::MonitorListRunsResponse::Data#target_type
+        module TargetType
+          extend ContextDev::Internal::Type::Enum
+
+          PAGE = :page
+          SITEMAP = :sitemap
+          EXTRACT = :extract
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see ContextDev::Models::MonitorListRunsResponse::Data#error
+        class Error < ContextDev::Internal::Type::BaseModel
+          # @!attribute code
+          #
+          #   @return [String]
+          required :code, String
+
+          # @!attribute message
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!method initialize(code:, message:)
+          #   @param code [String]
+          #   @param message [String]
+        end
+
+        # Why a skipped run never executed; null unless status is `skipped`.
+        #
+        # @see ContextDev::Models::MonitorListRunsResponse::Data#skip_reason
+        module SkipReason
+          extend ContextDev::Internal::Type::Enum
+
+          INSUFFICIENT_CREDITS = :insufficient_credits
+          MONITOR_PAUSED = :monitor_paused
+          SUPERSEDED = :superseded
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/monitor_retrieve_change_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Monitors#retrieve_change
+    class MonitorRetrieveChangeParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute change_id
+      #
+      #   @return [String]
+      required :change_id, String
+
+      # @!method initialize(change_id:, request_options: {})
+      #   @param change_id [String]
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/monitor_retrieve_change_response.rb

@@ -0,0 +1,271 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Monitors#retrieve_change
+    class MonitorRetrieveChangeResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute change_detection_type
+      #
+      #   @return [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::ChangeDetectionType]
+      required :change_detection_type,
+               enum: -> { ContextDev::Models::MonitorRetrieveChangeResponse::ChangeDetectionType }
+
+      # @!attribute detected_at
+      #
+      #   @return [Time]
+      required :detected_at, Time
+
+      # @!attribute mode
+      #   Top-level monitor category. Always `web` today; the concrete behavior is
+      #   described by `target` and `change_detection`.
+      #
+      #   @return [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::Mode]
+      required :mode, enum: -> { ContextDev::Models::MonitorRetrieveChangeResponse::Mode }
+
+      # @!attribute monitor_id
+      #
+      #   @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 target_type
+      #
+      #   @return [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::TargetType]
+      required :target_type, enum: -> { ContextDev::Models::MonitorRetrieveChangeResponse::TargetType }
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute url
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute added_url_count
+      #
+      #   @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::MonitorRetrieveChangeResponse::Evidence>, nil]
+      optional :evidence,
+               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorRetrieveChangeResponse::Evidence] }
+
+      # @!attribute importance
+      #
+      #   @return [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::Importance, nil]
+      optional :importance, enum: -> { ContextDev::Models::MonitorRetrieveChangeResponse::Importance }
+
+      # @!attribute matched_url_count
+      #
+      #   @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 query
+      #
+      #   @return [String, nil]
+      optional :query, String
+
+      # @!attribute removed_url_count
+      #
+      #   @return [Integer, nil]
+      optional :removed_url_count, Integer
+
+      # @!attribute removed_urls
+      #   At most 500 URLs are included; the corresponding count field is always exact.
+      #
+      #   @return [Array<String>, nil]
+      optional :removed_urls, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!attribute tags
+      #   User-defined tags for grouping and filtering monitors and their changes.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(id:, change_detection_type:, detected_at:, mode:, monitor_id:, run_id:, summary:, 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, query: nil, removed_url_count: nil, removed_urls: nil, tags: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::MonitorRetrieveChangeResponse} for more details.
+      #
+      #   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:
+      #   `query`/`confidence`/`importance`/`evidence`/`matched_urls`).
+      #
+      #   @param id [String]
+      #
+      #   @param change_detection_type [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::ChangeDetectionType]
+      #
+      #   @param detected_at [Time]
+      #
+      #   @param mode [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::Mode] Top-level monitor category. Always `web` today; the concrete behavior is describ
+      #
+      #   @param monitor_id [String]
+      #
+      #   @param run_id [String] The run that detected this change.
+      #
+      #   @param summary [String]
+      #
+      #   @param target_type [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::TargetType]
+      #
+      #   @param title [String]
+      #
+      #   @param url [String]
+      #
+      #   @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::MonitorRetrieveChangeResponse::Evidence>]
+      #
+      #   @param importance [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::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 query [String]
+      #
+      #   @param removed_url_count [Integer]
+      #
+      #   @param removed_urls [Array<String>] At most 500 URLs are included; the corresponding count field is always exact.
+      #
+      #   @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
+
+      # @see ContextDev::Models::MonitorRetrieveChangeResponse#change_detection_type
+      module ChangeDetectionType
+        extend ContextDev::Internal::Type::Enum
+
+        EXACT = :exact
+        SEMANTIC = :semantic
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Top-level monitor category. Always `web` today; the concrete behavior is
+      # described by `target` and `change_detection`.
+      #
+      # @see ContextDev::Models::MonitorRetrieveChangeResponse#mode
+      module Mode
+        extend ContextDev::Internal::Type::Enum
+
+        WEB = :web
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ContextDev::Models::MonitorRetrieveChangeResponse#target_type
+      module TargetType
+        extend ContextDev::Internal::Type::Enum
+
+        PAGE = :page
+        SITEMAP = :sitemap
+        EXTRACT = :extract
+
+        # @!method self.values
+        #   @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::MonitorRetrieveChangeResponse#importance
+      module Importance
+        extend ContextDev::Internal::Type::Enum
+
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/context_dev/models/monitor_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Monitors#retrieve
+    class MonitorRetrieveParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute monitor_id
+      #
+      #   @return [String]
+      required :monitor_id, String
+
+      # @!method initialize(monitor_id:, request_options: {})
+      #   @param monitor_id [String]
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end