context.dev 2.21.0 → 2.22.0

data/lib/context_dev/models/monitor_list_runs_params.rb

@@ -8,6 +8,7 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute monitor_id
+      #   ID of the monitor.
       #
       #   @return [String]
       required :monitor_id, String
@@ -31,7 +32,7 @@ module ContextDev
       optional :status, enum: -> { ContextDev::MonitorListRunsParams::Status }
 
       # @!method initialize(monitor_id:, cursor: nil, limit: nil, status: nil, request_options: {})
-      #   @param monitor_id [String]
+      #   @param monitor_id [String] ID of the monitor.
       #
       #   @param cursor [String] Opaque pagination cursor from a previous response.
       #

data/lib/context_dev/models/monitor_list_runs_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::MonitorListRunsResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::MonitorListRunsResponse::KeyMetadata }
+
+      # @!method initialize(data:, has_more:, next_cursor:, request_id:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::MonitorListRunsResponse} for more details.
+      #
       #   @param data [Array<ContextDev::Models::MonitorListRunsResponse::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::MonitorListRunsResponse::KeyMetadata] Credits this request used and your remaining balance.
 
       class Data < ContextDev::Internal::Type::BaseModel
         # @!attribute id
@@ -61,7 +83,7 @@ module ContextDev
         required :monitor_id, String
 
         # @!attribute run_type
-        #   The first run after monitor creation is a baseline run.
+        #   A baseline run follows creation or a target or detection change.
         #
         #   @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::RunType]
         required :run_type, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::RunType }
@@ -117,9 +139,7 @@ module ContextDev
         # @!attribute webhook_delivery
         #   @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.
+        #   Deprecated. Use `webhook_deliveries` for all attempts.
         #
         #   @return [ContextDev::Models::WebhookDelivery, nil]
         optional :webhook_delivery, -> { ContextDev::WebhookDelivery }
@@ -146,7 +166,7 @@ module ContextDev
         #
         #   @param monitor_id [String]
         #
-        #   @param run_type [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::RunType] The first run after monitor creation is a baseline run.
+        #   @param run_type [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::RunType] A baseline run follows creation or a target or detection change.
         #
         #   @param status [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::Status] Lifecycle status of a run. `skipped` runs never executed — see `skip_reason` (in
         #
@@ -164,7 +184,7 @@ module ContextDev
         #
         #   @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
+        #   @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated. Use `webhook_deliveries` for all attempts.
         #
         #   @param webhook_delivery_ids [Array<String>] Webhook delivery IDs for this run.
 
@@ -179,7 +199,7 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
 
-        # The first run after monitor creation is a baseline run.
+        # A baseline run follows creation or a target or detection change.
         #
         # @see ContextDev::Models::MonitorListRunsResponse::Data#run_type
         module RunType
@@ -252,6 +272,28 @@ module ContextDev
           #   @return [Array<Symbol>]
         end
       end
+
+      # @see ContextDev::Models::MonitorListRunsResponse#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_retrieve_change_params.rb

@@ -8,12 +8,14 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute change_id
+      #   ID of the detected change.
       #
       #   @return [String]
       required :change_id, String
 
       # @!method initialize(change_id:, request_options: {})
-      #   @param change_id [String]
+      #   @param change_id [String] ID of the detected change.
+      #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/context_dev/models/monitor_retrieve_change_response.rb

@@ -21,8 +21,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::MonitorRetrieveChangeResponse::Mode]
       required :mode, enum: -> { ContextDev::Models::MonitorRetrieveChangeResponse::Mode }
@@ -32,6 +31,13 @@ module ContextDev
       #   @return [String]
       required :monitor_id, String
 
+      # @!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 run_id
       #   The run that detected this change.
       #
@@ -44,8 +50,7 @@ module ContextDev
       required :summary, String
 
       # @!attribute tags
-      #   User-defined tags for grouping and filtering monitors and their changes.
-      #   Duplicates are removed.
+      #   Labels for filtering monitors, their changes, and their usage.
       #
       #   @return [Array<String>]
       required :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -108,6 +113,12 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::Importance, nil]
       optional :importance, enum: -> { ContextDev::Models::MonitorRetrieveChangeResponse::Importance }
 
+      # @!attribute key_metadata
+      #   Credits this request used and your remaining balance.
+      #
+      #   @return [ContextDev::Models::MonitorRetrieveChangeResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::MonitorRetrieveChangeResponse::KeyMetadata }
+
       # @!attribute matched_url_count
       #
       #   @return [Integer, nil]
@@ -130,31 +141,27 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :removed_urls, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!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)
+      # @!method initialize(id:, change_detection_type:, detected_at:, mode:, monitor_id:, request_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, key_metadata: 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.
       #
-      #   A detected change. `mode` is the constant `web`; `target_type` and
-      #   `change_detection_type` describe the change, and which optional fields are
-      #   present depends on them (page: `diff` + excerpts; sitemap:
-      #   `added_urls`/`removed_urls`; semantic:
-      #   `confidence`/`importance`/`evidence`/`matched_urls`).
-      #
       #   @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 mode [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::Mode] Always `web`. Optional.
       #
       #   @param monitor_id [String]
       #
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
+      #
       #   @param run_id [String] The run that detected this change.
       #
       #   @param summary [String]
       #
-      #   @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
+      #   @param tags [Array<String>] Labels for filtering monitors, their changes, and their usage.
       #
       #   @param target_type [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::TargetType]
       #
@@ -178,6 +185,8 @@ module ContextDev
       #
       #   @param importance [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::Importance]
       #
+      #   @param key_metadata [ContextDev::Models::MonitorRetrieveChangeResponse::KeyMetadata] Credits this request used and your remaining balance.
+      #
       #   @param matched_url_count [Integer]
       #
       #   @param matched_urls [Array<String>] At most 500 URLs are included; the corresponding count field is always exact.
@@ -197,8 +206,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::MonitorRetrieveChangeResponse#mode
       module Mode
@@ -260,6 +268,28 @@ module ContextDev
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # @see ContextDev::Models::MonitorRetrieveChangeResponse#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_retrieve_params.rb

@@ -8,12 +8,14 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute monitor_id
+      #   ID of the monitor.
       #
       #   @return [String]
       required :monitor_id, String
 
       # @!method initialize(monitor_id:, request_options: {})
-      #   @param monitor_id [String]
+      #   @param monitor_id [String] ID of the monitor.
+      #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
     end
   end