context.dev 1.35.0 → 2.0.0

data/lib/context_dev/models/monitor_list_changes_response.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Monitors#list_changes
+    class MonitorListChangesResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<ContextDev::Models::MonitorListChangesResponse::Data>]
+      required :data,
+               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorListChangesResponse::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::MonitorListChangesResponse::Data>]
+      #   @param has_more [Boolean]
+      #   @param next_cursor [String, nil]
+
+      class Data < ContextDev::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute change_detection_type
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::ChangeDetectionType]
+        required :change_detection_type,
+                 enum: -> { ContextDev::Models::MonitorListChangesResponse::Data::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::MonitorListChangesResponse::Data::Mode]
+        required :mode, enum: -> { ContextDev::Models::MonitorListChangesResponse::Data::Mode }
+
+        # @!attribute monitor_id
+        #
+        #   @return [String]
+        required :monitor_id, String
+
+        # @!attribute summary
+        #
+        #   @return [String]
+        required :summary, String
+
+        # @!attribute target_type
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::TargetType]
+        required :target_type, enum: -> { ContextDev::Models::MonitorListChangesResponse::Data::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 confidence
+        #
+        #   @return [Float, nil]
+        optional :confidence, Float
+
+        # @!attribute importance
+        #
+        #   @return [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::Importance, nil]
+        optional :importance, enum: -> { ContextDev::Models::MonitorListChangesResponse::Data::Importance }
+
+        # @!attribute matched_url_count
+        #
+        #   @return [Integer, nil]
+        optional :matched_url_count, Integer
+
+        # @!attribute removed_url_count
+        #
+        #   @return [Integer, nil]
+        optional :removed_url_count, Integer
+
+        # @!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:, summary:, target_type:, title:, url:, added_url_count: nil, confidence: nil, importance: nil, matched_url_count: nil, removed_url_count: nil, tags: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::MonitorListChangesResponse::Data} for more details.
+        #
+        #   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`).
+        #
+        #   @param id [String]
+        #
+        #   @param change_detection_type [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::ChangeDetectionType]
+        #
+        #   @param detected_at [Time]
+        #
+        #   @param mode [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::Mode] Top-level monitor category. Always `web` today; the concrete behavior is describ
+        #
+        #   @param monitor_id [String]
+        #
+        #   @param summary [String]
+        #
+        #   @param target_type [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::TargetType]
+        #
+        #   @param title [String]
+        #
+        #   @param url [String]
+        #
+        #   @param added_url_count [Integer]
+        #
+        #   @param confidence [Float]
+        #
+        #   @param importance [Symbol, ContextDev::Models::MonitorListChangesResponse::Data::Importance]
+        #
+        #   @param matched_url_count [Integer]
+        #
+        #   @param removed_url_count [Integer]
+        #
+        #   @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
+
+        # @see ContextDev::Models::MonitorListChangesResponse::Data#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::MonitorListChangesResponse::Data#mode
+        module Mode
+          extend ContextDev::Internal::Type::Enum
+
+          WEB = :web
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see ContextDev::Models::MonitorListChangesResponse::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::MonitorListChangesResponse::Data#importance
+        module Importance
+          extend ContextDev::Internal::Type::Enum
+
+          LOW = :low
+          MEDIUM = :medium
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/monitor_list_params.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Monitors#list
+    class MonitorListParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute change_detection_type
+      #
+      #   @return [Symbol, ContextDev::Models::MonitorListParams::ChangeDetectionType, nil]
+      optional :change_detection_type, enum: -> { ContextDev::MonitorListParams::ChangeDetectionType }
+
+      # @!attribute cursor
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute q
+      #   Free-text search term, matched against the fields named in `search_by`.
+      #
+      #   @return [String, nil]
+      optional :q, String
+
+      # @!attribute search_by
+      #   Comma-separated fields to search with `q`. Defaults to all of them. Note `query`
+      #   only exists on semantic monitors.
+      #
+      #   @return [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil]
+      optional :search_by,
+               -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorListParams::SearchBy] }
+
+      # @!attribute search_type
+      #   `prefix` for as-you-type prefix matching (default), `exact` for full-token
+      #   matching.
+      #
+      #   @return [Symbol, ContextDev::Models::MonitorListParams::SearchType, nil]
+      optional :search_type, enum: -> { ContextDev::MonitorListParams::SearchType }
+
+      # @!attribute status
+      #   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`.
+      #
+      #   @return [Symbol, ContextDev::Models::MonitorListParams::Status, nil]
+      optional :status, enum: -> { ContextDev::MonitorListParams::Status }
+
+      # @!attribute tag
+      #   Filter to items that have this tag.
+      #
+      #   @return [String, nil]
+      optional :tag, String
+
+      # @!attribute tags
+      #   Comma-separated list of tags to filter by (matches monitors having any of them).
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!attribute target_type
+      #
+      #   @return [Symbol, ContextDev::Models::MonitorListParams::TargetType, nil]
+      optional :target_type, enum: -> { ContextDev::MonitorListParams::TargetType }
+
+      # @!method initialize(change_detection_type: nil, cursor: nil, limit: nil, q: nil, search_by: nil, search_type: nil, status: nil, tag: nil, tags: nil, target_type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::MonitorListParams} for more details.
+      #
+      #   @param change_detection_type [Symbol, ContextDev::Models::MonitorListParams::ChangeDetectionType]
+      #
+      #   @param cursor [String]
+      #
+      #   @param limit [Integer]
+      #
+      #   @param q [String] Free-text search term, matched against the fields named in `search_by`.
+      #
+      #   @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>] Comma-separated fields to search with `q`. Defaults to all of them. Note `query`
+      #
+      #   @param search_type [Symbol, ContextDev::Models::MonitorListParams::SearchType] `prefix` for as-you-type prefix matching (default), `exact` for full-token match
+      #
+      #   @param status [Symbol, ContextDev::Models::MonitorListParams::Status] Monitor lifecycle status. `failed` means the most recent run failed (see the mon
+      #
+      #   @param tag [String] Filter to items that have this tag.
+      #
+      #   @param tags [Array<String>] Comma-separated list of tags to filter by (matches monitors having any of them).
+      #
+      #   @param target_type [Symbol, ContextDev::Models::MonitorListParams::TargetType]
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      module ChangeDetectionType
+        extend ContextDev::Internal::Type::Enum
+
+        EXACT = :exact
+        SEMANTIC = :semantic
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module SearchBy
+        extend ContextDev::Internal::Type::Enum
+
+        NAME = :name
+        URL = :url
+        QUERY = :query
+        TAGS = :tags
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # `prefix` for as-you-type prefix matching (default), `exact` for full-token
+      # matching.
+      module SearchType
+        extend ContextDev::Internal::Type::Enum
+
+        EXACT = :exact
+        PREFIX = :prefix
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      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
+
+        ACTIVE = :active
+        PAUSED = :paused
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module TargetType
+        extend ContextDev::Internal::Type::Enum
+
+        PAGE = :page
+        SITEMAP = :sitemap
+        EXTRACT = :extract
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end