context.dev 1.35.0 → 2.0.0

data/rbi/context_dev/models/utility_prefetch_params.rbi

@@ -14,9 +14,20 @@ module ContextDev
           )
         end
 
-      # Domain name to prefetch brand data for
-      sig { returns(String) }
-      attr_accessor :domain
+      # Identifier of the brand to prefetch. Provide exactly one of domain or email.
+      sig do
+        returns(
+          T.any(
+            ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier,
+            ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier
+          )
+        )
+      end
+      attr_accessor :identifier
+
+      # What to prefetch. Currently only 'brand' is supported.
+      sig { returns(ContextDev::UtilityPrefetchParams::Type::OrSymbol) }
+      attr_accessor :type
 
       # 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
@@ -29,14 +40,21 @@ module ContextDev
 
       sig do
         params(
-          domain: String,
+          identifier:
+            T.any(
+              ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier::OrHash,
+              ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier::OrHash
+            ),
+          type: ContextDev::UtilityPrefetchParams::Type::OrSymbol,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Domain name to prefetch brand data for
-        domain:,
+        # Identifier of the brand to prefetch. Provide exactly one of domain or email.
+        identifier:,
+        # What to prefetch. Currently only 'brand' is supported.
+        type:,
         # 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).
@@ -48,7 +66,12 @@ module ContextDev
       sig do
         override.returns(
           {
-            domain: String,
+            identifier:
+              T.any(
+                ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier,
+                ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier
+              ),
+            type: ContextDev::UtilityPrefetchParams::Type::OrSymbol,
             timeout_ms: Integer,
             request_options: ContextDev::RequestOptions
           }
@@ -56,6 +79,105 @@ module ContextDev
       end
       def to_hash
       end
+
+      # Identifier of the brand to prefetch. Provide exactly one of domain or email.
+      module Identifier
+        extend ContextDev::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier,
+              ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier
+            )
+          end
+
+        class UtilityPrefetchDomainIdentifier < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Domain name to prefetch brand data for
+          sig { returns(String) }
+          attr_accessor :domain
+
+          # Prefetch brand data by domain.
+          sig { params(domain: String).returns(T.attached_class) }
+          def self.new(
+            # Domain name to prefetch brand data for
+            domain:
+          )
+          end
+
+          sig { override.returns({ domain: String }) }
+          def to_hash
+          end
+        end
+
+        class UtilityPrefetchEmailIdentifier < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Email address to prefetch brand data for. The domain will be extracted from the
+          # email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+          # addresses are not allowed.
+          sig { returns(String) }
+          attr_accessor :email
+
+          # Prefetch brand data by email. The domain will be extracted and validated.
+          sig { params(email: String).returns(T.attached_class) }
+          def self.new(
+            # Email address to prefetch brand data for. The domain will be extracted from the
+            # email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+            # addresses are not allowed.
+            email:
+          )
+          end
+
+          sig { override.returns({ email: String }) }
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::UtilityPrefetchParams::Identifier::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+
+      # What to prefetch. Currently only 'brand' is supported.
+      module Type
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::UtilityPrefetchParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BRAND =
+          T.let(:brand, ContextDev::UtilityPrefetchParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::UtilityPrefetchParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/utility_prefetch_response.rbi

@@ -49,13 +49,32 @@ module ContextDev
       sig { params(status: String).void }
       attr_writer :status
 
+      # The type of prefetch that was queued, echoed from the request (currently always
+      # 'brand')
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::UtilityPrefetchResponse::Type::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :type
+
+      sig do
+        params(
+          type: ContextDev::Models::UtilityPrefetchResponse::Type::OrSymbol
+        ).void
+      end
+      attr_writer :type
+
       sig do
         params(
           domain: String,
           key_metadata:
             ContextDev::Models::UtilityPrefetchResponse::KeyMetadata::OrHash,
           message: String,
-          status: String
+          status: String,
+          type: ContextDev::Models::UtilityPrefetchResponse::Type::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -67,7 +86,10 @@ module ContextDev
         # Success message
         message: nil,
         # Status of the response, e.g., 'ok'
-        status: nil
+        status: nil,
+        # The type of prefetch that was queued, echoed from the request (currently always
+        # 'brand')
+        type: nil
       )
       end
 
@@ -78,7 +100,9 @@ module ContextDev
             key_metadata:
               ContextDev::Models::UtilityPrefetchResponse::KeyMetadata,
             message: String,
-            status: String
+            status: String,
+            type:
+              ContextDev::Models::UtilityPrefetchResponse::Type::TaggedSymbol
           }
         )
       end
@@ -125,6 +149,34 @@ module ContextDev
         def to_hash
         end
       end
+
+      # The type of prefetch that was queued, echoed from the request (currently always
+      # 'brand')
+      module Type
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::Models::UtilityPrefetchResponse::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BRAND =
+          T.let(
+            :brand,
+            ContextDev::Models::UtilityPrefetchResponse::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::UtilityPrefetchResponse::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_extract_response.rbi

@@ -106,6 +106,11 @@ module ContextDev
         sig { returns(Integer) }
         attr_accessor :max_crawl_depth
 
+        # Number of crawled pages excluded because they were anti-bot challenges, error
+        # pages, or parked-domain placeholders.
+        sig { returns(Integer) }
+        attr_accessor :num_blocked
+
         sig { returns(Integer) }
         attr_accessor :num_failed
 
@@ -121,6 +126,7 @@ module ContextDev
         sig do
           params(
             max_crawl_depth: Integer,
+            num_blocked: Integer,
             num_failed: Integer,
             num_skipped: Integer,
             num_succeeded: Integer,
@@ -129,6 +135,9 @@ module ContextDev
         end
         def self.new(
           max_crawl_depth:,
+          # Number of crawled pages excluded because they were anti-bot challenges, error
+          # pages, or parked-domain placeholders.
+          num_blocked:,
           num_failed:,
           num_skipped:,
           num_succeeded:,
@@ -140,6 +149,7 @@ module ContextDev
           override.returns(
             {
               max_crawl_depth: Integer,
+              num_blocked: Integer,
               num_failed: Integer,
               num_skipped: Integer,
               num_succeeded: Integer,

data/rbi/context_dev/models/web_extract_styleguide_params.rbi

@@ -14,6 +14,25 @@ module ContextDev
           )
         end
 
+      # Optional browser color scheme to emulate for websites that respond to
+      # prefers-color-scheme. This value is part of the styleguide cache key.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol
+          )
+        )
+      end
+      attr_reader :color_scheme
+
+      sig do
+        params(
+          color_scheme:
+            ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol
+        ).void
+      end
+      attr_writer :color_scheme
+
       # A specific URL to fetch the styleguide from directly, bypassing domain
       # resolution (e.g., 'https://example.com/design-system'). When provided, the
       # styleguide is extracted from this exact URL. You must provide either 'domain' or
@@ -54,6 +73,8 @@ module ContextDev
 
       sig do
         params(
+          color_scheme:
+            ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol,
           direct_url: String,
           domain: String,
           max_age_ms: Integer,
@@ -62,6 +83,9 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Optional browser color scheme to emulate for websites that respond to
+        # prefers-color-scheme. This value is part of the styleguide cache key.
+        color_scheme: nil,
         # A specific URL to fetch the styleguide from directly, bypassing domain
         # resolution (e.g., 'https://example.com/design-system'). When provided, the
         # styleguide is extracted from this exact URL. You must provide either 'domain' or
@@ -87,6 +111,8 @@ module ContextDev
       sig do
         override.returns(
           {
+            color_scheme:
+              ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol,
             direct_url: String,
             domain: String,
             max_age_ms: Integer,
@@ -97,6 +123,39 @@ module ContextDev
       end
       def to_hash
       end
+
+      # Optional browser color scheme to emulate for websites that respond to
+      # prefers-color-scheme. This value is part of the styleguide cache key.
+      module ColorScheme
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::WebExtractStyleguideParams::ColorScheme)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIGHT =
+          T.let(
+            :light,
+            ContextDev::WebExtractStyleguideParams::ColorScheme::TaggedSymbol
+          )
+        DARK =
+          T.let(
+            :dark,
+            ContextDev::WebExtractStyleguideParams::ColorScheme::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::WebExtractStyleguideParams::ColorScheme::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end