context.dev 1.36.0 → 2.0.0

data/rbi/context_dev/models/monitor_list_changes_response.rbi

@@ -0,0 +1,372 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class MonitorListChangesResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::MonitorListChangesResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(T::Array[ContextDev::Models::MonitorListChangesResponse::Data])
+      end
+      attr_accessor :data
+
+      sig { returns(T::Boolean) }
+      attr_accessor :has_more
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :next_cursor
+
+      sig do
+        params(
+          data:
+            T::Array[
+              ContextDev::Models::MonitorListChangesResponse::Data::OrHash
+            ],
+          has_more: T::Boolean,
+          next_cursor: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, has_more:, next_cursor:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T::Array[ContextDev::Models::MonitorListChangesResponse::Data],
+            has_more: T::Boolean,
+            next_cursor: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorListChangesResponse::Data,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          returns(
+            ContextDev::Models::MonitorListChangesResponse::Data::ChangeDetectionType::TaggedSymbol
+          )
+        end
+        attr_accessor :change_detection_type
+
+        sig { returns(Time) }
+        attr_accessor :detected_at
+
+        # Top-level monitor category. Always `web` today; the concrete behavior is
+        # described by `target` and `change_detection`.
+        sig do
+          returns(
+            ContextDev::Models::MonitorListChangesResponse::Data::Mode::TaggedSymbol
+          )
+        end
+        attr_accessor :mode
+
+        sig { returns(String) }
+        attr_accessor :monitor_id
+
+        sig { returns(String) }
+        attr_accessor :summary
+
+        sig do
+          returns(
+            ContextDev::Models::MonitorListChangesResponse::Data::TargetType::TaggedSymbol
+          )
+        end
+        attr_accessor :target_type
+
+        sig { returns(String) }
+        attr_accessor :title
+
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :added_url_count
+
+        sig { params(added_url_count: Integer).void }
+        attr_writer :added_url_count
+
+        sig { returns(T.nilable(Float)) }
+        attr_reader :confidence
+
+        sig { params(confidence: Float).void }
+        attr_writer :confidence
+
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::MonitorListChangesResponse::Data::Importance::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :importance
+
+        sig do
+          params(
+            importance:
+              ContextDev::Models::MonitorListChangesResponse::Data::Importance::OrSymbol
+          ).void
+        end
+        attr_writer :importance
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :matched_url_count
+
+        sig { params(matched_url_count: Integer).void }
+        attr_writer :matched_url_count
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :removed_url_count
+
+        sig { params(removed_url_count: Integer).void }
+        attr_writer :removed_url_count
+
+        # User-defined tags for grouping and filtering monitors and their changes.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :tags
+
+        sig { params(tags: T::Array[String]).void }
+        attr_writer :tags
+
+        # 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`).
+        sig do
+          params(
+            id: String,
+            change_detection_type:
+              ContextDev::Models::MonitorListChangesResponse::Data::ChangeDetectionType::OrSymbol,
+            detected_at: Time,
+            mode:
+              ContextDev::Models::MonitorListChangesResponse::Data::Mode::OrSymbol,
+            monitor_id: String,
+            summary: String,
+            target_type:
+              ContextDev::Models::MonitorListChangesResponse::Data::TargetType::OrSymbol,
+            title: String,
+            url: String,
+            added_url_count: Integer,
+            confidence: Float,
+            importance:
+              ContextDev::Models::MonitorListChangesResponse::Data::Importance::OrSymbol,
+            matched_url_count: Integer,
+            removed_url_count: Integer,
+            tags: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          change_detection_type:,
+          detected_at:,
+          # Top-level monitor category. Always `web` today; the concrete behavior is
+          # described by `target` and `change_detection`.
+          mode:,
+          monitor_id:,
+          summary:,
+          target_type:,
+          title:,
+          url:,
+          added_url_count: nil,
+          confidence: nil,
+          importance: nil,
+          matched_url_count: nil,
+          removed_url_count: nil,
+          # User-defined tags for grouping and filtering monitors and their changes.
+          tags: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              change_detection_type:
+                ContextDev::Models::MonitorListChangesResponse::Data::ChangeDetectionType::TaggedSymbol,
+              detected_at: Time,
+              mode:
+                ContextDev::Models::MonitorListChangesResponse::Data::Mode::TaggedSymbol,
+              monitor_id: String,
+              summary: String,
+              target_type:
+                ContextDev::Models::MonitorListChangesResponse::Data::TargetType::TaggedSymbol,
+              title: String,
+              url: String,
+              added_url_count: Integer,
+              confidence: Float,
+              importance:
+                ContextDev::Models::MonitorListChangesResponse::Data::Importance::TaggedSymbol,
+              matched_url_count: Integer,
+              removed_url_count: Integer,
+              tags: 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::MonitorListChangesResponse::Data::ChangeDetectionType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXACT =
+            T.let(
+              :exact,
+              ContextDev::Models::MonitorListChangesResponse::Data::ChangeDetectionType::TaggedSymbol
+            )
+          SEMANTIC =
+            T.let(
+              :semantic,
+              ContextDev::Models::MonitorListChangesResponse::Data::ChangeDetectionType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::MonitorListChangesResponse::Data::ChangeDetectionType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Top-level monitor category. Always `web` today; the concrete behavior is
+        # described by `target` and `change_detection`.
+        module Mode
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::MonitorListChangesResponse::Data::Mode
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          WEB =
+            T.let(
+              :web,
+              ContextDev::Models::MonitorListChangesResponse::Data::Mode::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::MonitorListChangesResponse::Data::Mode::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module TargetType
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::MonitorListChangesResponse::Data::TargetType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PAGE =
+            T.let(
+              :page,
+              ContextDev::Models::MonitorListChangesResponse::Data::TargetType::TaggedSymbol
+            )
+          SITEMAP =
+            T.let(
+              :sitemap,
+              ContextDev::Models::MonitorListChangesResponse::Data::TargetType::TaggedSymbol
+            )
+          EXTRACT =
+            T.let(
+              :extract,
+              ContextDev::Models::MonitorListChangesResponse::Data::TargetType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::MonitorListChangesResponse::Data::TargetType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Importance
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::MonitorListChangesResponse::Data::Importance
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW =
+            T.let(
+              :low,
+              ContextDev::Models::MonitorListChangesResponse::Data::Importance::TaggedSymbol
+            )
+          MEDIUM =
+            T.let(
+              :medium,
+              ContextDev::Models::MonitorListChangesResponse::Data::Importance::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              ContextDev::Models::MonitorListChangesResponse::Data::Importance::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::MonitorListChangesResponse::Data::Importance::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/monitor_list_params.rbi

@@ -0,0 +1,332 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class MonitorListParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::MonitorListParams, ContextDev::Internal::AnyHash)
+        end
+
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::MonitorListParams::ChangeDetectionType::OrSymbol
+          )
+        )
+      end
+      attr_reader :change_detection_type
+
+      sig do
+        params(
+          change_detection_type:
+            ContextDev::MonitorListParams::ChangeDetectionType::OrSymbol
+        ).void
+      end
+      attr_writer :change_detection_type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Free-text search term, matched against the fields named in `search_by`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :q
+
+      sig { params(q: String).void }
+      attr_writer :q
+
+      # Comma-separated fields to search with `q`. Defaults to all of them. Note `query`
+      # only exists on semantic monitors.
+      sig do
+        returns(
+          T.nilable(T::Array[ContextDev::MonitorListParams::SearchBy::OrSymbol])
+        )
+      end
+      attr_reader :search_by
+
+      sig do
+        params(
+          search_by: T::Array[ContextDev::MonitorListParams::SearchBy::OrSymbol]
+        ).void
+      end
+      attr_writer :search_by
+
+      # `prefix` for as-you-type prefix matching (default), `exact` for full-token
+      # matching.
+      sig do
+        returns(T.nilable(ContextDev::MonitorListParams::SearchType::OrSymbol))
+      end
+      attr_reader :search_type
+
+      sig do
+        params(
+          search_type: ContextDev::MonitorListParams::SearchType::OrSymbol
+        ).void
+      end
+      attr_writer :search_type
+
+      # Monitor lifecycle status. `failed` means the most recent run failed (see the
+      # monitor's `last_error`); failed monitors keep running on schedule and flip back
+      # to `active` on the next successful run. Monitors are auto-`paused` after
+      # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
+      # status to `active`.
+      sig do
+        returns(T.nilable(ContextDev::MonitorListParams::Status::OrSymbol))
+      end
+      attr_reader :status
+
+      sig do
+        params(status: ContextDev::MonitorListParams::Status::OrSymbol).void
+      end
+      attr_writer :status
+
+      # Filter to items that have this tag.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tag
+
+      sig { params(tag: String).void }
+      attr_writer :tag
+
+      # Comma-separated list of tags to filter by (matches monitors having any of them).
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
+      sig do
+        returns(T.nilable(ContextDev::MonitorListParams::TargetType::OrSymbol))
+      end
+      attr_reader :target_type
+
+      sig do
+        params(
+          target_type: ContextDev::MonitorListParams::TargetType::OrSymbol
+        ).void
+      end
+      attr_writer :target_type
+
+      sig do
+        params(
+          change_detection_type:
+            ContextDev::MonitorListParams::ChangeDetectionType::OrSymbol,
+          cursor: String,
+          limit: Integer,
+          q: String,
+          search_by:
+            T::Array[ContextDev::MonitorListParams::SearchBy::OrSymbol],
+          search_type: ContextDev::MonitorListParams::SearchType::OrSymbol,
+          status: ContextDev::MonitorListParams::Status::OrSymbol,
+          tag: String,
+          tags: T::Array[String],
+          target_type: ContextDev::MonitorListParams::TargetType::OrSymbol,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        change_detection_type: nil,
+        cursor: nil,
+        limit: nil,
+        # Free-text search term, matched against the fields named in `search_by`.
+        q: nil,
+        # Comma-separated fields to search with `q`. Defaults to all of them. Note `query`
+        # only exists on semantic monitors.
+        search_by: nil,
+        # `prefix` for as-you-type prefix matching (default), `exact` for full-token
+        # matching.
+        search_type: nil,
+        # Monitor lifecycle status. `failed` means the most recent run failed (see the
+        # monitor's `last_error`); failed monitors keep running on schedule and flip back
+        # to `active` on the next successful run. Monitors are auto-`paused` after
+        # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
+        # status to `active`.
+        status: nil,
+        # Filter to items that have this tag.
+        tag: nil,
+        # Comma-separated list of tags to filter by (matches monitors having any of them).
+        tags: nil,
+        target_type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            change_detection_type:
+              ContextDev::MonitorListParams::ChangeDetectionType::OrSymbol,
+            cursor: String,
+            limit: Integer,
+            q: String,
+            search_by:
+              T::Array[ContextDev::MonitorListParams::SearchBy::OrSymbol],
+            search_type: ContextDev::MonitorListParams::SearchType::OrSymbol,
+            status: ContextDev::MonitorListParams::Status::OrSymbol,
+            tag: String,
+            tags: T::Array[String],
+            target_type: ContextDev::MonitorListParams::TargetType::OrSymbol,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module ChangeDetectionType
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::MonitorListParams::ChangeDetectionType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXACT =
+          T.let(
+            :exact,
+            ContextDev::MonitorListParams::ChangeDetectionType::TaggedSymbol
+          )
+        SEMANTIC =
+          T.let(
+            :semantic,
+            ContextDev::MonitorListParams::ChangeDetectionType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::MonitorListParams::ChangeDetectionType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module SearchBy
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::MonitorListParams::SearchBy)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NAME =
+          T.let(:name, ContextDev::MonitorListParams::SearchBy::TaggedSymbol)
+        URL = T.let(:url, ContextDev::MonitorListParams::SearchBy::TaggedSymbol)
+        QUERY =
+          T.let(:query, ContextDev::MonitorListParams::SearchBy::TaggedSymbol)
+        TAGS =
+          T.let(:tags, ContextDev::MonitorListParams::SearchBy::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::MonitorListParams::SearchBy::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # `prefix` for as-you-type prefix matching (default), `exact` for full-token
+      # matching.
+      module SearchType
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::MonitorListParams::SearchType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXACT =
+          T.let(:exact, ContextDev::MonitorListParams::SearchType::TaggedSymbol)
+        PREFIX =
+          T.let(
+            :prefix,
+            ContextDev::MonitorListParams::SearchType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::MonitorListParams::SearchType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Monitor lifecycle status. `failed` means the most recent run failed (see the
+      # monitor's `last_error`); failed monitors keep running on schedule and flip back
+      # to `active` on the next successful run. Monitors are auto-`paused` after
+      # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
+      # status to `active`.
+      module Status
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ContextDev::MonitorListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, ContextDev::MonitorListParams::Status::TaggedSymbol)
+        PAUSED =
+          T.let(:paused, ContextDev::MonitorListParams::Status::TaggedSymbol)
+        FAILED =
+          T.let(:failed, ContextDev::MonitorListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::MonitorListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module TargetType
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::MonitorListParams::TargetType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAGE =
+          T.let(:page, ContextDev::MonitorListParams::TargetType::TaggedSymbol)
+        SITEMAP =
+          T.let(
+            :sitemap,
+            ContextDev::MonitorListParams::TargetType::TaggedSymbol
+          )
+        EXTRACT =
+          T.let(
+            :extract,
+            ContextDev::MonitorListParams::TargetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::MonitorListParams::TargetType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end