context.dev 2.17.1 → 2.19.0

data/rbi/context_dev/models/monitor_retrieve_run_response.rbi

@@ -0,0 +1,452 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class MonitorRetrieveRunResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::MonitorRetrieveRunResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # True when this run established the monitor's initial baseline; baseline runs
+      # perform no change detection.
+      sig { returns(T::Boolean) }
+      attr_accessor :baseline_created
+
+      sig { returns(T::Boolean) }
+      attr_accessor :change_detected
+
+      sig do
+        returns(
+          ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType::TaggedSymbol
+        )
+      end
+      attr_accessor :change_detection_type
+
+      # Credits charged for this run (0 for skipped/failed runs).
+      sig { returns(Integer) }
+      attr_accessor :credits_charged
+
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
+      # The first run after monitor creation is a baseline run.
+      sig do
+        returns(
+          ContextDev::Models::MonitorRetrieveRunResponse::RunType::TaggedSymbol
+        )
+      end
+      attr_accessor :run_type
+
+      # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
+      # (insufficient credits, monitor paused, or superseded by a concurrent run).
+      sig do
+        returns(
+          ContextDev::Models::MonitorRetrieveRunResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      sig do
+        returns(
+          ContextDev::Models::MonitorRetrieveRunResponse::TargetType::TaggedSymbol
+        )
+      end
+      attr_accessor :target_type
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :change_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :completed_at
+
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::MonitorRetrieveRunResponse::Error)
+        )
+      end
+      attr_reader :error
+
+      sig do
+        params(
+          error:
+            T.nilable(
+              ContextDev::Models::MonitorRetrieveRunResponse::Error::OrHash
+            )
+        ).void
+      end
+      attr_writer :error
+
+      # Why a skipped run never executed; null unless status is `skipped`.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::MonitorRetrieveRunResponse::SkipReason::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :skip_reason
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :started_at
+
+      # 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.
+      sig { returns(T.nilable(T::Array[ContextDev::WebhookDelivery])) }
+      attr_reader :webhook_deliveries
+
+      sig do
+        params(
+          webhook_deliveries: T::Array[ContextDev::WebhookDelivery::OrHash]
+        ).void
+      end
+      attr_writer :webhook_deliveries
+
+      # 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.
+      sig { returns(T.nilable(ContextDev::WebhookDelivery)) }
+      attr_reader :webhook_delivery
+
+      sig { params(webhook_delivery: ContextDev::WebhookDelivery::OrHash).void }
+      attr_writer :webhook_delivery
+
+      # Webhook delivery IDs for this run.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :webhook_delivery_ids
+
+      sig { params(webhook_delivery_ids: T::Array[String]).void }
+      attr_writer :webhook_delivery_ids
+
+      sig do
+        params(
+          id: String,
+          baseline_created: T::Boolean,
+          change_detected: T::Boolean,
+          change_detection_type:
+            ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType::OrSymbol,
+          credits_charged: Integer,
+          monitor_id: String,
+          run_type:
+            ContextDev::Models::MonitorRetrieveRunResponse::RunType::OrSymbol,
+          status:
+            ContextDev::Models::MonitorRetrieveRunResponse::Status::OrSymbol,
+          target_type:
+            ContextDev::Models::MonitorRetrieveRunResponse::TargetType::OrSymbol,
+          change_id: T.nilable(String),
+          completed_at: T.nilable(Time),
+          error:
+            T.nilable(
+              ContextDev::Models::MonitorRetrieveRunResponse::Error::OrHash
+            ),
+          skip_reason:
+            T.nilable(
+              ContextDev::Models::MonitorRetrieveRunResponse::SkipReason::OrSymbol
+            ),
+          started_at: T.nilable(Time),
+          webhook_deliveries: T::Array[ContextDev::WebhookDelivery::OrHash],
+          webhook_delivery: ContextDev::WebhookDelivery::OrHash,
+          webhook_delivery_ids: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # True when this run established the monitor's initial baseline; baseline runs
+        # perform no change detection.
+        baseline_created:,
+        change_detected:,
+        change_detection_type:,
+        # Credits charged for this run (0 for skipped/failed runs).
+        credits_charged:,
+        monitor_id:,
+        # The first run after monitor creation is a baseline run.
+        run_type:,
+        # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
+        # (insufficient credits, monitor paused, or superseded by a concurrent run).
+        status:,
+        target_type:,
+        change_id: nil,
+        completed_at: nil,
+        error: nil,
+        # Why a skipped run never executed; null unless status is `skipped`.
+        skip_reason: nil,
+        started_at: nil,
+        # 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.
+        webhook_deliveries: nil,
+        # 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.
+        webhook_delivery: nil,
+        # Webhook delivery IDs for this run.
+        webhook_delivery_ids: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            baseline_created: T::Boolean,
+            change_detected: T::Boolean,
+            change_detection_type:
+              ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType::TaggedSymbol,
+            credits_charged: Integer,
+            monitor_id: String,
+            run_type:
+              ContextDev::Models::MonitorRetrieveRunResponse::RunType::TaggedSymbol,
+            status:
+              ContextDev::Models::MonitorRetrieveRunResponse::Status::TaggedSymbol,
+            target_type:
+              ContextDev::Models::MonitorRetrieveRunResponse::TargetType::TaggedSymbol,
+            change_id: T.nilable(String),
+            completed_at: T.nilable(Time),
+            error:
+              T.nilable(ContextDev::Models::MonitorRetrieveRunResponse::Error),
+            skip_reason:
+              T.nilable(
+                ContextDev::Models::MonitorRetrieveRunResponse::SkipReason::TaggedSymbol
+              ),
+            started_at: T.nilable(Time),
+            webhook_deliveries: T::Array[ContextDev::WebhookDelivery],
+            webhook_delivery: ContextDev::WebhookDelivery,
+            webhook_delivery_ids: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module ChangeDetectionType
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXACT =
+          T.let(
+            :exact,
+            ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType::TaggedSymbol
+          )
+        SEMANTIC =
+          T.let(
+            :semantic,
+            ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The first run after monitor creation is a baseline run.
+      module RunType
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::MonitorRetrieveRunResponse::RunType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BASELINE =
+          T.let(
+            :baseline,
+            ContextDev::Models::MonitorRetrieveRunResponse::RunType::TaggedSymbol
+          )
+        SCHEDULED =
+          T.let(
+            :scheduled,
+            ContextDev::Models::MonitorRetrieveRunResponse::RunType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::MonitorRetrieveRunResponse::RunType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
+      # (insufficient credits, monitor paused, or superseded by a concurrent run).
+      module Status
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::MonitorRetrieveRunResponse::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUED =
+          T.let(
+            :queued,
+            ContextDev::Models::MonitorRetrieveRunResponse::Status::TaggedSymbol
+          )
+        RUNNING =
+          T.let(
+            :running,
+            ContextDev::Models::MonitorRetrieveRunResponse::Status::TaggedSymbol
+          )
+        COMPLETED =
+          T.let(
+            :completed,
+            ContextDev::Models::MonitorRetrieveRunResponse::Status::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :failed,
+            ContextDev::Models::MonitorRetrieveRunResponse::Status::TaggedSymbol
+          )
+        SKIPPED =
+          T.let(
+            :skipped,
+            ContextDev::Models::MonitorRetrieveRunResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::MonitorRetrieveRunResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module TargetType
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::MonitorRetrieveRunResponse::TargetType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAGE =
+          T.let(
+            :page,
+            ContextDev::Models::MonitorRetrieveRunResponse::TargetType::TaggedSymbol
+          )
+        SITEMAP =
+          T.let(
+            :sitemap,
+            ContextDev::Models::MonitorRetrieveRunResponse::TargetType::TaggedSymbol
+          )
+        EXTRACT =
+          T.let(
+            :extract,
+            ContextDev::Models::MonitorRetrieveRunResponse::TargetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::MonitorRetrieveRunResponse::TargetType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Error < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorRetrieveRunResponse::Error,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :code
+
+        sig { returns(String) }
+        attr_accessor :message
+
+        sig { params(code: String, message: String).returns(T.attached_class) }
+        def self.new(code:, message:)
+        end
+
+        sig { override.returns({ code: String, message: String }) }
+        def to_hash
+        end
+      end
+
+      # Why a skipped run never executed; null unless status is `skipped`.
+      module SkipReason
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::MonitorRetrieveRunResponse::SkipReason
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INSUFFICIENT_CREDITS =
+          T.let(
+            :insufficient_credits,
+            ContextDev::Models::MonitorRetrieveRunResponse::SkipReason::TaggedSymbol
+          )
+        MONITOR_PAUSED =
+          T.let(
+            :monitor_paused,
+            ContextDev::Models::MonitorRetrieveRunResponse::SkipReason::TaggedSymbol
+          )
+        SUPERSEDED =
+          T.let(
+            :superseded,
+            ContextDev::Models::MonitorRetrieveRunResponse::SkipReason::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::MonitorRetrieveRunResponse::SkipReason::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class MonitorRotateWebhookSecretParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::MonitorRotateWebhookSecretParams,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
+      sig do
+        params(
+          monitor_id: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(monitor_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { monitor_id: String, request_options: ContextDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end