context.dev 2.3.0 → 2.5.0

data/rbi/context_dev/models/web_web_scrape_images_params.rbi

@@ -18,14 +18,48 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # Optional browser actions executed in array order after the page loads and before
+      # content is captured. Requires a paid plan. Send a JSON array in the query
+      # parameter. Maximum: 5 actions.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(
+                ContextDev::WebWebScrapeImagesParams::Action::Wait,
+                ContextDev::WebWebScrapeImagesParams::Action::Perform
+              )
+            ]
+          )
+        )
+      end
+      attr_accessor :actions
+
       # When true, visually duplicate images are removed: every image is loaded and
       # perceptually hashed, and only the highest-resolution copy of each duplicate
       # group is kept. Images that cannot be downloaded or hashed are kept. Default:
       # false.
-      sig { returns(T.nilable(T::Boolean)) }
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              T::Boolean,
+              ContextDev::WebWebScrapeImagesParams::Dedupe::OrSymbol
+            )
+          )
+        )
+      end
       attr_reader :dedupe
 
-      sig { params(dedupe: T::Boolean).void }
+      sig do
+        params(
+          dedupe:
+            T.any(
+              T::Boolean,
+              ContextDev::WebWebScrapeImagesParams::Dedupe::OrSymbol
+            )
+        ).void
+      end
       attr_writer :dedupe
 
       # Optional per-image processing, sent as deep-object query params such as
@@ -37,7 +71,8 @@ module ContextDev
 
       sig do
         params(
-          enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash
+          enrichment:
+            T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash)
         ).void
       end
       attr_writer :enrichment
@@ -54,10 +89,16 @@ module ContextDev
       # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
       # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
       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 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
@@ -71,26 +112,42 @@ module ContextDev
       # Optional browser wait time in milliseconds after initial page load before
       # collecting images. Min: 0. Max: 30000 (30 seconds).
       sig { returns(T.nilable(Integer)) }
-      attr_reader :wait_for_ms
-
-      sig { params(wait_for_ms: Integer).void }
-      attr_writer :wait_for_ms
+      attr_accessor :wait_for_ms
 
       sig do
         params(
           url: String,
-          dedupe: T::Boolean,
-          enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash,
+          actions:
+            T.nilable(
+              T::Array[
+                T.any(
+                  ContextDev::WebWebScrapeImagesParams::Action::Wait::OrHash,
+                  ContextDev::WebWebScrapeImagesParams::Action::Perform::OrHash
+                )
+              ]
+            ),
+          dedupe:
+            T.any(
+              T::Boolean,
+              ContextDev::WebWebScrapeImagesParams::Dedupe::OrSymbol
+            ),
+          enrichment:
+            T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash),
           headers: T::Hash[Symbol, String],
-          max_age_ms: Integer,
+          max_age_ms: T.nilable(Integer),
+          tags: T::Array[String],
           timeout_ms: Integer,
-          wait_for_ms: Integer,
+          wait_for_ms: T.nilable(Integer),
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # Page URL to inspect. Must include http:// or https://.
         url:,
+        # Optional browser actions executed in array order after the page loads and before
+        # content is captured. Requires a paid plan. Send a JSON array in the query
+        # parameter. Maximum: 5 actions.
+        actions: nil,
         # When true, visually duplicate images are removed: every image is loaded and
         # perceptually hashed, and only the highest-resolution copy of each duplicate
         # group is kept. Images that cannot be downloaded or hashed are kept. Default:
@@ -106,6 +163,10 @@ module ContextDev
         # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
         # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
         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 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).
@@ -121,12 +182,27 @@ module ContextDev
         override.returns(
           {
             url: String,
-            dedupe: T::Boolean,
-            enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment,
+            actions:
+              T.nilable(
+                T::Array[
+                  T.any(
+                    ContextDev::WebWebScrapeImagesParams::Action::Wait,
+                    ContextDev::WebWebScrapeImagesParams::Action::Perform
+                  )
+                ]
+              ),
+            dedupe:
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Dedupe::OrSymbol
+              ),
+            enrichment:
+              T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment),
             headers: T::Hash[Symbol, String],
-            max_age_ms: Integer,
+            max_age_ms: T.nilable(Integer),
+            tags: T::Array[String],
             timeout_ms: Integer,
-            wait_for_ms: Integer,
+            wait_for_ms: T.nilable(Integer),
             request_options: ContextDev::RequestOptions
           }
         )
@@ -134,6 +210,121 @@ module ContextDev
       def to_hash
       end
 
+      # Browser action discriminated by `do`. Each variant exposes only its applicable
+      # fields.
+      module Action
+        extend ContextDev::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              ContextDev::WebWebScrapeImagesParams::Action::Wait,
+              ContextDev::WebWebScrapeImagesParams::Action::Perform
+            )
+          end
+
+        class Wait < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::WebWebScrapeImagesParams::Action::Wait,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Symbol) }
+          attr_accessor :do_
+
+          sig { returns(Integer) }
+          attr_accessor :time_ms
+
+          # Pause for a fixed number of milliseconds before continuing to the next action.
+          sig do
+            params(time_ms: Integer, do_: Symbol).returns(T.attached_class)
+          end
+          def self.new(time_ms:, do_: :wait)
+          end
+
+          sig { override.returns({ do_: Symbol, time_ms: Integer }) }
+          def to_hash
+          end
+        end
+
+        class Perform < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::WebWebScrapeImagesParams::Action::Perform,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :action
+
+          sig { returns(Symbol) }
+          attr_accessor :do_
+
+          # Resolve and perform one natural-language browser action.
+          sig { params(action: String, do_: Symbol).returns(T.attached_class) }
+          def self.new(action:, do_: :perform)
+          end
+
+          sig { override.returns({ action: String, do_: Symbol }) }
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebWebScrapeImagesParams::Action::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+
+      # When true, visually duplicate images are removed: every image is loaded and
+      # perceptually hashed, and only the highest-resolution copy of each duplicate
+      # group is kept. Images that cannot be downloaded or hashed are kept. Default:
+      # false.
+      module Dedupe
+        extend ContextDev::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              T::Boolean,
+              ContextDev::WebWebScrapeImagesParams::Dedupe::TaggedSymbol
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebWebScrapeImagesParams::Dedupe::Variants]
+          )
+        end
+        def self.variants
+        end
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::WebWebScrapeImagesParams::Dedupe)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRUE =
+          T.let(
+            :true,
+            ContextDev::WebWebScrapeImagesParams::Dedupe::TaggedSymbol
+          )
+        FALSE =
+          T.let(
+            :false,
+            ContextDev::WebWebScrapeImagesParams::Dedupe::TaggedSymbol
+          )
+      end
+
       class Enrichment < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -144,18 +335,52 @@ module ContextDev
           end
 
         # Classify each image by visual asset type.
-        sig { returns(T.nilable(T::Boolean)) }
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Classification::OrSymbol
+              )
+            )
+          )
+        end
         attr_reader :classification
 
-        sig { params(classification: T::Boolean).void }
+        sig do
+          params(
+            classification:
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Classification::OrSymbol
+              )
+          ).void
+        end
         attr_writer :classification
 
         # Host materializable images on the Brand.dev CDN and return their URL and MIME
         # type.
-        sig { returns(T.nilable(T::Boolean)) }
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL::OrSymbol
+              )
+            )
+          )
+        end
         attr_reader :hosted_url
 
-        sig { params(hosted_url: T::Boolean).void }
+        sig do
+          params(
+            hosted_url:
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL::OrSymbol
+              )
+          ).void
+        end
         attr_writer :hosted_url
 
         # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
@@ -166,20 +391,49 @@ module ContextDev
         attr_writer :max_time_per_ms
 
         # Measure image width and height when possible.
-        sig { returns(T.nilable(T::Boolean)) }
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution::OrSymbol
+              )
+            )
+          )
+        end
         attr_reader :resolution
 
-        sig { params(resolution: T::Boolean).void }
+        sig do
+          params(
+            resolution:
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution::OrSymbol
+              )
+          ).void
+        end
         attr_writer :resolution
 
         # Optional per-image processing, sent as deep-object query params such as
         # enrichment[resolution]=true.
         sig do
           params(
-            classification: T::Boolean,
-            hosted_url: T::Boolean,
+            classification:
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Classification::OrSymbol
+              ),
+            hosted_url:
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL::OrSymbol
+              ),
             max_time_per_ms: Integer,
-            resolution: T::Boolean
+            resolution:
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution::OrSymbol
+              )
           ).returns(T.attached_class)
         end
         def self.new(
@@ -198,15 +452,157 @@ module ContextDev
         sig do
           override.returns(
             {
-              classification: T::Boolean,
-              hosted_url: T::Boolean,
+              classification:
+                T.any(
+                  T::Boolean,
+                  ContextDev::WebWebScrapeImagesParams::Enrichment::Classification::OrSymbol
+                ),
+              hosted_url:
+                T.any(
+                  T::Boolean,
+                  ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL::OrSymbol
+                ),
               max_time_per_ms: Integer,
-              resolution: T::Boolean
+              resolution:
+                T.any(
+                  T::Boolean,
+                  ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution::OrSymbol
+                )
             }
           )
         end
         def to_hash
         end
+
+        # Classify each image by visual asset type.
+        module Classification
+          extend ContextDev::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Classification::TaggedSymbol
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Classification::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Classification
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TRUE =
+            T.let(
+              :true,
+              ContextDev::WebWebScrapeImagesParams::Enrichment::Classification::TaggedSymbol
+            )
+          FALSE =
+            T.let(
+              :false,
+              ContextDev::WebWebScrapeImagesParams::Enrichment::Classification::TaggedSymbol
+            )
+        end
+
+        # Host materializable images on the Brand.dev CDN and return their URL and MIME
+        # type.
+        module HostedURL
+          extend ContextDev::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL::TaggedSymbol
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TRUE =
+            T.let(
+              :true,
+              ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL::TaggedSymbol
+            )
+          FALSE =
+            T.let(
+              :false,
+              ContextDev::WebWebScrapeImagesParams::Enrichment::HostedURL::TaggedSymbol
+            )
+        end
+
+        # Measure image width and height when possible.
+        module Resolution
+          extend ContextDev::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution::TaggedSymbol
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TRUE =
+            T.let(
+              :true,
+              ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution::TaggedSymbol
+            )
+          FALSE =
+            T.let(
+              :false,
+              ContextDev::WebWebScrapeImagesParams::Enrichment::Resolution::TaggedSymbol
+            )
+        end
       end
     end
   end