context.dev 2.4.0 → 2.5.0

data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi

@@ -23,10 +23,31 @@ module ContextDev
       # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
       # year.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :max_age_ms
+      attr_accessor :max_age_ms
 
-      sig { params(max_age_ms: Integer).void }
-      attr_writer :max_age_ms
+      # Optional comma-separated caller-defined tags for tracking this request. Tags are
+      # recorded on the request's usage log and can be used to filter usage on the
+      # dashboard usage page. Up to 20 tags, each 1-50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
+      # Optional theme preference used when selecting brand assets.
+      sig do
+        returns(
+          T.nilable(ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol)
+        )
+      end
+      attr_reader :theme
+
+      sig do
+        params(
+          theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol
+        ).void
+      end
+      attr_writer :theme
 
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -40,7 +61,9 @@ module ContextDev
       sig do
         params(
           domain: String,
-          max_age_ms: Integer,
+          max_age_ms: T.nilable(Integer),
+          tags: T::Array[String],
+          theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -53,6 +76,12 @@ module ContextDev
         # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
         # year.
         max_age_ms: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
+        # Optional theme preference used when selecting brand assets.
+        theme: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -65,7 +94,9 @@ module ContextDev
         override.returns(
           {
             domain: String,
-            max_age_ms: Integer,
+            max_age_ms: T.nilable(Integer),
+            tags: T::Array[String],
+            theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions
           }
@@ -73,6 +104,38 @@ module ContextDev
       end
       def to_hash
       end
+
+      # Optional theme preference used when selecting brand assets.
+      module Theme
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::BrandRetrieveSimplifiedParams::Theme)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIGHT =
+          T.let(
+            :light,
+            ContextDev::BrandRetrieveSimplifiedParams::Theme::TaggedSymbol
+          )
+        DARK =
+          T.let(
+            :dark,
+            ContextDev::BrandRetrieveSimplifiedParams::Theme::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::BrandRetrieveSimplifiedParams::Theme::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/industry_retrieve_naics_params.rbi

@@ -35,6 +35,15 @@ module ContextDev
       sig { params(min_results: Integer).void }
       attr_writer :min_results
 
+      # Optional comma-separated caller-defined tags for tracking this request. Tags are
+      # recorded on the request's usage log and can be used to filter usage on the
+      # dashboard usage page. Up to 20 tags, each 1-50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
       # value is 300000ms (5 minutes).
@@ -49,6 +58,7 @@ module ContextDev
           input: String,
           max_results: Integer,
           min_results: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -63,6 +73,10 @@ module ContextDev
         max_results: nil,
         # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
         min_results: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -77,6 +91,7 @@ module ContextDev
             input: String,
             max_results: Integer,
             min_results: Integer,
+            tags: T::Array[String],
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions
           }

data/rbi/context_dev/models/industry_retrieve_sic_params.rbi

@@ -34,6 +34,15 @@ module ContextDev
       sig { params(min_results: Integer).void }
       attr_writer :min_results
 
+      # Optional comma-separated caller-defined tags for tracking this request. Tags are
+      # recorded on the request's usage log and can be used to filter usage on the
+      # dashboard usage page. Up to 20 tags, each 1-50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
       # value is 300000ms (5 minutes).
@@ -63,6 +72,7 @@ module ContextDev
           input: String,
           max_results: Integer,
           min_results: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
@@ -77,6 +87,10 @@ module ContextDev
         max_results: nil,
         # Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
         min_results: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -95,6 +109,7 @@ module ContextDev
             input: String,
             max_results: Integer,
             min_results: Integer,
+            tags: T::Array[String],
             timeout_ms: Integer,
             type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
             request_options: ContextDev::RequestOptions

data/rbi/context_dev/models/monitor_create_params.rbi

@@ -59,6 +59,7 @@ module ContextDev
       attr_writer :mode
 
       # User-defined tags for grouping and filtering monitors and their changes.
+      # Duplicates are removed.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -110,6 +111,7 @@ module ContextDev
         # described by `target` and `change_detection`.
         mode: nil,
         # User-defined tags for grouping and filtering monitors and their changes.
+        # Duplicates are removed.
         tags: nil,
         webhook: nil,
         request_options: {}
@@ -418,14 +420,14 @@ module ContextDev
           sig { returns(String) }
           attr_accessor :url
 
-          # URL path patterns to exclude.
+          # URL path patterns to exclude (max 50).
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :exclude
 
           sig { params(exclude: T::Array[String]).void }
           attr_writer :exclude
 
-          # URL path patterns to include.
+          # URL path patterns to include (max 50).
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :include
 
@@ -456,9 +458,9 @@ module ContextDev
           def self.new(
             # Sitemap URL to monitor.
             url:,
-            # URL path patterns to exclude.
+            # URL path patterns to exclude (max 50).
             exclude: nil,
-            # URL path patterns to include.
+            # URL path patterns to include (max 50).
             include: nil,
             # Maximum number of sitemap URLs to track (capped at 10,000).
             max_urls: nil,

data/rbi/context_dev/models/monitor_create_response.rbi

@@ -107,6 +107,7 @@ module ContextDev
       attr_accessor :next_run_at
 
       # User-defined tags for grouping and filtering monitors and their changes.
+      # Duplicates are removed.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -230,6 +231,7 @@ module ContextDev
         # When the next scheduled run is due.
         next_run_at: nil,
         # User-defined tags for grouping and filtering monitors and their changes.
+        # Duplicates are removed.
         tags: nil,
         webhook: nil,
         # Present while webhook deliveries are failing consecutively; null when deliveries
@@ -636,14 +638,14 @@ module ContextDev
           sig { returns(String) }
           attr_accessor :url
 
-          # URL path patterns to exclude.
+          # URL path patterns to exclude (max 50).
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :exclude
 
           sig { params(exclude: T::Array[String]).void }
           attr_writer :exclude
 
-          # URL path patterns to include.
+          # URL path patterns to include (max 50).
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :include
 
@@ -674,9 +676,9 @@ module ContextDev
           def self.new(
             # Sitemap URL to monitor.
             url:,
-            # URL path patterns to exclude.
+            # URL path patterns to exclude (max 50).
             exclude: nil,
-            # URL path patterns to include.
+            # URL path patterns to include (max 50).
             include: nil,
             # Maximum number of sitemap URLs to track (capped at 10,000).
             max_urls: nil,

data/rbi/context_dev/models/monitor_get_credit_usage_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class MonitorGetCreditUsageParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::MonitorGetCreditUsageParams,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Only include items at or after this ISO 8601 timestamp.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :since
+
+      sig { params(since: Time).void }
+      attr_writer :since
+
+      # Only include items before this ISO 8601 timestamp.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :until_
+
+      sig { params(until_: Time).void }
+      attr_writer :until_
+
+      sig do
+        params(
+          since: Time,
+          until_: Time,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Only include items at or after this ISO 8601 timestamp.
+        since: nil,
+        # Only include items before this ISO 8601 timestamp.
+        until_: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            since: Time,
+            until_: Time,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class MonitorGetCreditUsageResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::MonitorGetCreditUsageResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T::Array[ContextDev::Models::MonitorGetCreditUsageResponse::Data]
+        )
+      end
+      attr_accessor :data
+
+      # Sum of credits across all monitors in the window.
+      sig { returns(Integer) }
+      attr_accessor :total_credits
+
+      sig do
+        params(
+          data:
+            T::Array[
+              ContextDev::Models::MonitorGetCreditUsageResponse::Data::OrHash
+            ],
+          total_credits: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Sum of credits across all monitors in the window.
+        total_credits:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T::Array[ContextDev::Models::MonitorGetCreditUsageResponse::Data],
+            total_credits: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorGetCreditUsageResponse::Data,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits charged to this monitor over the window.
+        sig { returns(Integer) }
+        attr_accessor :credits
+
+        sig { returns(String) }
+        attr_accessor :monitor_id
+
+        # Monitor name (falls back to the id when the monitor was deleted).
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Number of billed runs over the window.
+        sig { returns(Integer) }
+        attr_accessor :runs
+
+        sig do
+          params(
+            credits: Integer,
+            monitor_id: String,
+            name: String,
+            runs: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Credits charged to this monitor over the window.
+          credits:,
+          monitor_id:,
+          # Monitor name (falls back to the id when the monitor was deleted).
+          name:,
+          # Number of billed runs over the window.
+          runs:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              credits: Integer,
+              monitor_id: String,
+              name: String,
+              runs: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/monitor_get_limits_params.rbi

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

data/rbi/context_dev/models/monitor_get_limits_response.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class MonitorGetLimitsResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::MonitorGetLimitsResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Maximum number of monitors allowed for the account. Defaults to the plan
+      # allowance unless a custom limit is set for the organization.
+      sig { returns(Integer) }
+      attr_accessor :monitors_limit
+
+      # Number of monitors the account currently has.
+      sig { returns(Integer) }
+      attr_accessor :monitors_used
+
+      # The plan tier the limit was resolved from.
+      sig do
+        returns(
+          ContextDev::Models::MonitorGetLimitsResponse::Plan::TaggedSymbol
+        )
+      end
+      attr_accessor :plan
+
+      sig do
+        params(
+          monitors_limit: Integer,
+          monitors_used: Integer,
+          plan: ContextDev::Models::MonitorGetLimitsResponse::Plan::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Maximum number of monitors allowed for the account. Defaults to the plan
+        # allowance unless a custom limit is set for the organization.
+        monitors_limit:,
+        # Number of monitors the account currently has.
+        monitors_used:,
+        # The plan tier the limit was resolved from.
+        plan:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            monitors_limit: Integer,
+            monitors_used: Integer,
+            plan:
+              ContextDev::Models::MonitorGetLimitsResponse::Plan::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The plan tier the limit was resolved from.
+      module Plan
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::Models::MonitorGetLimitsResponse::Plan)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FREE =
+          T.let(
+            :free,
+            ContextDev::Models::MonitorGetLimitsResponse::Plan::TaggedSymbol
+          )
+        STARTER =
+          T.let(
+            :starter,
+            ContextDev::Models::MonitorGetLimitsResponse::Plan::TaggedSymbol
+          )
+        PRO =
+          T.let(
+            :pro,
+            ContextDev::Models::MonitorGetLimitsResponse::Plan::TaggedSymbol
+          )
+        SCALE =
+          T.let(
+            :scale,
+            ContextDev::Models::MonitorGetLimitsResponse::Plan::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::MonitorGetLimitsResponse::Plan::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/monitor_list_account_changes_params.rbi

@@ -14,6 +14,7 @@ module ContextDev
           )
         end
 
+      # Filter by change detection type.
       sig do
         returns(
           T.nilable(
@@ -31,24 +32,28 @@ module ContextDev
       end
       attr_writer :change_detection_type
 
+      # Opaque pagination cursor from a previous response.
       sig { returns(T.nilable(String)) }
       attr_reader :cursor
 
       sig { params(cursor: String).void }
       attr_writer :cursor
 
+      # Maximum number of items to return per page (1-100). Defaults to 25.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
       sig { params(limit: Integer).void }
       attr_writer :limit
 
+      # Filter changes to a single monitor.
       sig { returns(T.nilable(String)) }
       attr_reader :monitor_id
 
       sig { params(monitor_id: String).void }
       attr_writer :monitor_id
 
+      # Only include items at or after this ISO 8601 timestamp.
       sig { returns(T.nilable(Time)) }
       attr_reader :since
 
@@ -62,6 +67,7 @@ module ContextDev
       sig { params(tag: String).void }
       attr_writer :tag
 
+      # Filter by target type.
       sig do
         returns(
           T.nilable(
@@ -79,6 +85,7 @@ module ContextDev
       end
       attr_writer :target_type
 
+      # Only include items before this ISO 8601 timestamp.
       sig { returns(T.nilable(Time)) }
       attr_reader :until_
 
@@ -101,14 +108,21 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Filter by change detection type.
         change_detection_type: nil,
+        # Opaque pagination cursor from a previous response.
         cursor: nil,
+        # Maximum number of items to return per page (1-100). Defaults to 25.
         limit: nil,
+        # Filter changes to a single monitor.
         monitor_id: nil,
+        # Only include items at or after this ISO 8601 timestamp.
         since: nil,
         # Filter to items that have this tag.
         tag: nil,
+        # Filter by target type.
         target_type: nil,
+        # Only include items before this ISO 8601 timestamp.
         until_: nil,
         request_options: {}
       )
@@ -134,6 +148,7 @@ module ContextDev
       def to_hash
       end
 
+      # Filter by change detection type.
       module ChangeDetectionType
         extend ContextDev::Internal::Type::Enum
 
@@ -168,6 +183,7 @@ module ContextDev
         end
       end
 
+      # Filter by target type.
       module TargetType
         extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/monitor_list_account_changes_response.rbi

@@ -144,6 +144,7 @@ module ContextDev
         attr_writer :removed_url_count
 
         # User-defined tags for grouping and filtering monitors and their changes.
+        # Duplicates are removed.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :tags
 
@@ -196,6 +197,7 @@ module ContextDev
           matched_url_count: nil,
           removed_url_count: nil,
           # User-defined tags for grouping and filtering monitors and their changes.
+          # Duplicates are removed.
           tags: nil
         )
         end