context.dev 2.2.0 → 2.4.0

data/lib/context_dev/models/monitor_list_runs_response.rb

@@ -106,15 +106,25 @@ module ContextDev
         #   @return [Time, nil]
         optional :started_at, Time, nil?: true
 
+        # @!attribute webhook_deliveries
+        #   All webhook deliveries attempted by this run — one per subscribed event that
+        #   fired. Omitted when no webhook was attempted, including runs created before
+        #   event selection was added.
+        #
+        #   @return [Array<ContextDev::Models::WebhookDelivery>, nil]
+        optional :webhook_deliveries, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::WebhookDelivery] }
+
         # @!attribute webhook_delivery
-        #   The webhook delivery attempted for a change detected by this run. Omitted when
-        #   no webhook was attempted, including historical runs created before delivery
-        #   tracking was added.
+        #   @deprecated
+        #
+        #   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.
         #
-        #   @return [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery, nil]
-        optional :webhook_delivery, -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery }
+        #   @return [ContextDev::Models::WebhookDelivery, nil]
+        optional :webhook_delivery, -> { ContextDev::WebhookDelivery }
 
-        # @!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, webhook_delivery: nil)
+        # @!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, webhook_deliveries: nil, webhook_delivery: nil)
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::MonitorListRunsResponse::Data} for more details.
         #
@@ -146,7 +156,9 @@ module ContextDev
         #
         #   @param started_at [Time, nil]
         #
-        #   @param webhook_delivery [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] The webhook delivery attempted for a change detected by this run. Omitted when n
+        #   @param webhook_deliveries [Array<ContextDev::Models::WebhookDelivery>] All webhook deliveries attempted by this run — one per subscribed event that fir
+        #
+        #   @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run
 
         # @see ContextDev::Models::MonitorListRunsResponse::Data#change_detection_type
         module ChangeDetectionType
@@ -231,95 +243,6 @@ module ContextDev
           # @!method self.values
           #   @return [Array<Symbol>]
         end
-
-        # @see ContextDev::Models::MonitorListRunsResponse::Data#webhook_delivery
-        class WebhookDelivery < ContextDev::Internal::Type::BaseModel
-          # @!attribute attempted_at
-          #
-          #   @return [Time]
-          required :attempted_at, Time
-
-          # @!attribute error
-          #
-          #   @return [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error, nil]
-          required :error,
-                   -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error },
-                   nil?: true
-
-          # @!attribute event_id
-          #   Identifier sent in the X-Context-Id header.
-          #
-          #   @return [String]
-          required :event_id, String
-
-          # @!attribute http_status
-          #   The endpoint's final HTTP response status, or null when no response was
-          #   received.
-          #
-          #   @return [Integer, nil]
-          required :http_status, Integer, nil?: true
-
-          # @!attribute status
-          #   Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
-          #   response; failed means no HTTP response was received; skipped_unsafe_url means
-          #   the URL failed the public-endpoint safety check.
-          #
-          #   @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status]
-          required :status, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status }
-
-          # @!method initialize(attempted_at:, error:, event_id:, http_status:, status:)
-          #   Some parameter documentations has been truncated, see
-          #   {ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery} for more
-          #   details.
-          #
-          #   The webhook delivery attempted for a change detected by this run. Omitted when
-          #   no webhook was attempted, including historical runs created before delivery
-          #   tracking was added.
-          #
-          #   @param attempted_at [Time]
-          #
-          #   @param error [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error, nil]
-          #
-          #   @param event_id [String] Identifier sent in the X-Context-Id header.
-          #
-          #   @param http_status [Integer, nil] The endpoint's final HTTP response status, or null when no response was received
-          #
-          #   @param status [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status] Delivery outcome. delivered means any 2xx response; rejected means a non-2xx res
-
-          # @see ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery#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
-
-          # Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
-          # response; failed means no HTTP response was received; skipped_unsafe_url means
-          # the URL failed the public-endpoint safety check.
-          #
-          # @see ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery#status
-          module Status
-            extend ContextDev::Internal::Type::Enum
-
-            DELIVERED = :delivered
-            REJECTED = :rejected
-            FAILED = :failed
-            SKIPPED_UNSAFE_URL = :skipped_unsafe_url
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
       end
     end
   end

data/lib/context_dev/models/monitor_retrieve_change_response.rb

@@ -43,6 +43,12 @@ module ContextDev
       #   @return [String]
       required :summary, String
 
+      # @!attribute tags
+      #   User-defined tags for grouping and filtering monitors and their changes.
+      #
+      #   @return [Array<String>]
+      required :tags, ContextDev::Internal::Type::ArrayOf[String]
+
       # @!attribute target_type
       #
       #   @return [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::TargetType]
@@ -123,13 +129,7 @@ module ContextDev
       #   @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, removed_url_count: nil, removed_urls: nil, tags: nil)
+      # @!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)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::MonitorRetrieveChangeResponse} for more details.
       #
@@ -137,7 +137,7 @@ module ContextDev
       #   `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`).
+      #   `confidence`/`importance`/`evidence`/`matched_urls`).
       #
       #   @param id [String]
       #
@@ -153,6 +153,8 @@ module ContextDev
       #
       #   @param summary [String]
       #
+      #   @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
+      #
       #   @param target_type [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::TargetType]
       #
       #   @param title [String]
@@ -182,8 +184,6 @@ module ContextDev
       #   @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

data/lib/context_dev/models/monitor_retrieve_response.rb

@@ -103,7 +103,15 @@ module ContextDev
       #   @return [ContextDev::Models::MonitorRetrieveResponse::Webhook, nil]
       optional :webhook, -> { ContextDev::Models::MonitorRetrieveResponse::Webhook }, nil?: true
 
-      # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil)
+      # @!attribute webhook_failure
+      #   Present while webhook deliveries are failing consecutively; null when deliveries
+      #   are healthy or no webhook is configured. Cleared on the next successful delivery
+      #   and when the webhook URL changes.
+      #
+      #   @return [ContextDev::Models::MonitorRetrieveResponse::WebhookFailure, nil]
+      optional :webhook_failure, -> { ContextDev::Models::MonitorRetrieveResponse::WebhookFailure }, nil?: true
+
+      # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil, webhook_failure: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::MonitorRetrieveResponse} for more details.
       #
@@ -141,6 +149,8 @@ module ContextDev
       #   @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
       #
       #   @param webhook [ContextDev::Models::MonitorRetrieveResponse::Webhook, nil]
+      #
+      #   @param webhook_failure [ContextDev::Models::MonitorRetrieveResponse::WebhookFailure, nil] Present while webhook deliveries are failing consecutively; null when deliveries
 
       # Discriminated union describing how changes are detected.
       #
@@ -583,11 +593,21 @@ module ContextDev
       # @see ContextDev::Models::MonitorRetrieveResponse#webhook
       class Webhook < ContextDev::Internal::Type::BaseModel
         # @!attribute url
-        #   Webhook URL called when a change is detected.
+        #   Webhook URL events are delivered to.
         #
         #   @return [String]
         required :url, String
 
+        # @!attribute events
+        #   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.
+        #
+        #   @return [Array<Symbol, ContextDev::Models::MonitorRetrieveResponse::Webhook::Event>, nil]
+        optional :events,
+                 -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorRetrieveResponse::Webhook::Event] }
+
         response_only do
           # @!attribute secret
           #   Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -600,13 +620,86 @@ module ContextDev
           optional :secret, String
         end
 
-        # @!method initialize(url:, secret: nil)
+        # @!method initialize(url:, events: nil, secret: nil)
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::MonitorRetrieveResponse::Webhook} for more details.
         #
-        #   @param url [String] Webhook URL called when a change is detected.
+        #   @param url [String] Webhook URL events are delivered to.
+        #
+        #   @param events [Array<Symbol, ContextDev::Models::MonitorRetrieveResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
         #
         #   @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
+
+        module Event
+          extend ContextDev::Internal::Type::Enum
+
+          CHANGE_DETECTED = :"change.detected"
+          RUN_COMPLETED = :"run.completed"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see ContextDev::Models::MonitorRetrieveResponse#webhook_failure
+      class WebhookFailure < ContextDev::Internal::Type::BaseModel
+        # @!attribute consecutive_failures
+        #   Number of consecutive delivery attempts that did not succeed.
+        #
+        #   @return [Integer]
+        required :consecutive_failures, Integer
+
+        # @!attribute last_failed_at
+        #
+        #   @return [Time]
+        required :last_failed_at, Time
+
+        # @!attribute last_message
+        #   Human-readable description of the most recent failure.
+        #
+        #   @return [String]
+        required :last_message, String
+
+        # @!attribute last_status
+        #   Outcome of the most recent failed delivery. rejected means a non-2xx response;
+        #   failed means no HTTP response was received; skipped_unsafe_url means the URL
+        #   failed the public-endpoint safety check.
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus]
+        required :last_status,
+                 enum: -> { ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus }
+
+        # @!method initialize(consecutive_failures:, last_failed_at:, last_message:, last_status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::MonitorRetrieveResponse::WebhookFailure} for more details.
+        #
+        #   Present while webhook deliveries are failing consecutively; null when deliveries
+        #   are healthy or no webhook is configured. Cleared on the next successful delivery
+        #   and when the webhook URL changes.
+        #
+        #   @param consecutive_failures [Integer] Number of consecutive delivery attempts that did not succeed.
+        #
+        #   @param last_failed_at [Time]
+        #
+        #   @param last_message [String] Human-readable description of the most recent failure.
+        #
+        #   @param last_status [Symbol, ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus] Outcome of the most recent failed delivery. rejected means a non-2xx response; f
+
+        # Outcome of the most recent failed delivery. rejected means a non-2xx response;
+        # failed means no HTTP response was received; skipped_unsafe_url means the URL
+        # failed the public-endpoint safety check.
+        #
+        # @see ContextDev::Models::MonitorRetrieveResponse::WebhookFailure#last_status
+        module LastStatus
+          extend ContextDev::Internal::Type::Enum
+
+          REJECTED = :rejected
+          FAILED = :failed
+          SKIPPED_UNSAFE_URL = :skipped_unsafe_url
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/context_dev/models/monitor_update_params.rb

@@ -361,15 +361,40 @@ module ContextDev
 
       class Webhook < ContextDev::Internal::Type::BaseModel
         # @!attribute url
-        #   Webhook URL called when a change is detected.
+        #   Webhook URL events are delivered to.
         #
         #   @return [String]
         required :url, String
 
-        # @!method initialize(url:)
+        # @!attribute events
+        #   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.
+        #
+        #   @return [Array<Symbol, ContextDev::Models::MonitorUpdateParams::Webhook::Event>, nil]
+        optional :events,
+                 -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorUpdateParams::Webhook::Event] }
+
+        # @!method initialize(url:, events: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::MonitorUpdateParams::Webhook} for more details.
+        #
         #   Set to null to remove the webhook.
         #
-        #   @param url [String] Webhook URL called when a change is detected.
+        #   @param url [String] Webhook URL events are delivered to.
+        #
+        #   @param events [Array<Symbol, ContextDev::Models::MonitorUpdateParams::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
+
+        module Event
+          extend ContextDev::Internal::Type::Enum
+
+          CHANGE_DETECTED = :"change.detected"
+          RUN_COMPLETED = :"run.completed"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/context_dev/models/monitor_update_response.rb

@@ -103,7 +103,15 @@ module ContextDev
       #   @return [ContextDev::Models::MonitorUpdateResponse::Webhook, nil]
       optional :webhook, -> { ContextDev::Models::MonitorUpdateResponse::Webhook }, nil?: true
 
-      # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil)
+      # @!attribute webhook_failure
+      #   Present while webhook deliveries are failing consecutively; null when deliveries
+      #   are healthy or no webhook is configured. Cleared on the next successful delivery
+      #   and when the webhook URL changes.
+      #
+      #   @return [ContextDev::Models::MonitorUpdateResponse::WebhookFailure, nil]
+      optional :webhook_failure, -> { ContextDev::Models::MonitorUpdateResponse::WebhookFailure }, nil?: true
+
+      # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil, webhook_failure: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::MonitorUpdateResponse} for more details.
       #
@@ -141,6 +149,8 @@ module ContextDev
       #   @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
       #
       #   @param webhook [ContextDev::Models::MonitorUpdateResponse::Webhook, nil]
+      #
+      #   @param webhook_failure [ContextDev::Models::MonitorUpdateResponse::WebhookFailure, nil] Present while webhook deliveries are failing consecutively; null when deliveries
 
       # Discriminated union describing how changes are detected.
       #
@@ -583,11 +593,21 @@ module ContextDev
       # @see ContextDev::Models::MonitorUpdateResponse#webhook
       class Webhook < ContextDev::Internal::Type::BaseModel
         # @!attribute url
-        #   Webhook URL called when a change is detected.
+        #   Webhook URL events are delivered to.
         #
         #   @return [String]
         required :url, String
 
+        # @!attribute events
+        #   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.
+        #
+        #   @return [Array<Symbol, ContextDev::Models::MonitorUpdateResponse::Webhook::Event>, nil]
+        optional :events,
+                 -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorUpdateResponse::Webhook::Event] }
+
         response_only do
           # @!attribute secret
           #   Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -600,13 +620,85 @@ module ContextDev
           optional :secret, String
         end
 
-        # @!method initialize(url:, secret: nil)
+        # @!method initialize(url:, events: nil, secret: nil)
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::MonitorUpdateResponse::Webhook} for more details.
         #
-        #   @param url [String] Webhook URL called when a change is detected.
+        #   @param url [String] Webhook URL events are delivered to.
+        #
+        #   @param events [Array<Symbol, ContextDev::Models::MonitorUpdateResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
         #
         #   @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
+
+        module Event
+          extend ContextDev::Internal::Type::Enum
+
+          CHANGE_DETECTED = :"change.detected"
+          RUN_COMPLETED = :"run.completed"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see ContextDev::Models::MonitorUpdateResponse#webhook_failure
+      class WebhookFailure < ContextDev::Internal::Type::BaseModel
+        # @!attribute consecutive_failures
+        #   Number of consecutive delivery attempts that did not succeed.
+        #
+        #   @return [Integer]
+        required :consecutive_failures, Integer
+
+        # @!attribute last_failed_at
+        #
+        #   @return [Time]
+        required :last_failed_at, Time
+
+        # @!attribute last_message
+        #   Human-readable description of the most recent failure.
+        #
+        #   @return [String]
+        required :last_message, String
+
+        # @!attribute last_status
+        #   Outcome of the most recent failed delivery. rejected means a non-2xx response;
+        #   failed means no HTTP response was received; skipped_unsafe_url means the URL
+        #   failed the public-endpoint safety check.
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus]
+        required :last_status, enum: -> { ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus }
+
+        # @!method initialize(consecutive_failures:, last_failed_at:, last_message:, last_status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::MonitorUpdateResponse::WebhookFailure} for more details.
+        #
+        #   Present while webhook deliveries are failing consecutively; null when deliveries
+        #   are healthy or no webhook is configured. Cleared on the next successful delivery
+        #   and when the webhook URL changes.
+        #
+        #   @param consecutive_failures [Integer] Number of consecutive delivery attempts that did not succeed.
+        #
+        #   @param last_failed_at [Time]
+        #
+        #   @param last_message [String] Human-readable description of the most recent failure.
+        #
+        #   @param last_status [Symbol, ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus] Outcome of the most recent failed delivery. rejected means a non-2xx response; f
+
+        # Outcome of the most recent failed delivery. rejected means a non-2xx response;
+        # failed means no HTTP response was received; skipped_unsafe_url means the URL
+        # failed the public-endpoint safety check.
+        #
+        # @see ContextDev::Models::MonitorUpdateResponse::WebhookFailure#last_status
+        module LastStatus
+          extend ContextDev::Internal::Type::Enum
+
+          REJECTED = :rejected
+          FAILED = :failed
+          SKIPPED_UNSAFE_URL = :skipped_unsafe_url
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end