context.dev 2.18.0 → 2.19.0

data/rbi/context_dev/models/web_web_scrape_images_params.rbi

@@ -1,728 +0,0 @@
-# typed: strong
-
-module ContextDev
-  module Models
-    class WebWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            ContextDev::WebWebScrapeImagesParams,
-            ContextDev::Internal::AnyHash
-          )
-        end
-
-      # Page URL to inspect. Must include http:// or https://.
-      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,
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll
-              )
-            ]
-          )
-        )
-      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)) }
-      attr_reader :dedupe
-
-      sig { params(dedupe: T::Boolean).void }
-      attr_writer :dedupe
-
-      # Optional per-image processing, sent as deep-object query params such as
-      # enrichment[resolution]=true.
-      sig do
-        returns(T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment))
-      end
-      attr_reader :enrichment
-
-      sig do
-        params(
-          enrichment:
-            T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash)
-        ).void
-      end
-      attr_writer :enrichment
-
-      # Optional outbound HTTP headers forwarded only to the target URL, sent as
-      # deep-object query params such as headers[X-Custom]=value. When provided, caching
-      # is bypassed: the result is neither read from nor written to cache.
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
-      attr_reader :headers
-
-      sig { params(headers: T::Hash[Symbol, String]).void }
-      attr_writer :headers
-
-      # 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_accessor :max_age_ms
-
-      # Comma-separated tags for tracking request usage. 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 request deadline and behavior on timeout. For GET requests, use
-      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      # timeoutOpts object.
-      sig do
-        returns(T.nilable(ContextDev::WebWebScrapeImagesParams::TimeoutOpts))
-      end
-      attr_reader :timeout_opts
-
-      sig do
-        params(
-          timeout_opts:
-            ContextDev::WebWebScrapeImagesParams::TimeoutOpts::OrHash
-        ).void
-      end
-      attr_writer :timeout_opts
-
-      # Optional browser wait time in milliseconds after initial page load before
-      # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
-      # timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000 ms; a
-      # shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
-      sig { returns(T.nilable(Integer)) }
-      attr_accessor :wait_for_ms
-
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
-      sig do
-        returns(T.nilable(ContextDev::WebWebScrapeImagesParams::Zdr::OrSymbol))
-      end
-      attr_reader :zdr
-
-      sig do
-        params(zdr: ContextDev::WebWebScrapeImagesParams::Zdr::OrSymbol).void
-      end
-      attr_writer :zdr
-
-      sig do
-        params(
-          url: String,
-          actions:
-            T.nilable(
-              T::Array[
-                T.any(
-                  ContextDev::WebWebScrapeImagesParams::Action::Wait::OrHash,
-                  ContextDev::WebWebScrapeImagesParams::Action::Perform::OrHash,
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::OrHash
-                )
-              ]
-            ),
-          dedupe: T::Boolean,
-          enrichment:
-            T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash),
-          headers: T::Hash[Symbol, String],
-          max_age_ms: T.nilable(Integer),
-          tags: T::Array[String],
-          timeout_opts:
-            ContextDev::WebWebScrapeImagesParams::TimeoutOpts::OrHash,
-          wait_for_ms: T.nilable(Integer),
-          zdr: ContextDev::WebWebScrapeImagesParams::Zdr::OrSymbol,
-          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:
-        # false.
-        dedupe: nil,
-        # Optional per-image processing, sent as deep-object query params such as
-        # enrichment[resolution]=true.
-        enrichment: nil,
-        # Optional outbound HTTP headers forwarded only to the target URL, sent as
-        # deep-object query params such as headers[X-Custom]=value. When provided, caching
-        # is bypassed: the result is neither read from nor written to cache.
-        headers: nil,
-        # 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,
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
-        tags: nil,
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
-        timeout_opts: nil,
-        # Optional browser wait time in milliseconds after initial page load before
-        # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
-        # timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000 ms; a
-        # shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
-        wait_for_ms: nil,
-        # Set to enabled to bypass shared caches and omit request and response content
-        # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-        # omitted. Requires zero data retention to be enabled for your organization
-        # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-        # Successful ZDR responses include X-Context-ZDR: true.
-        zdr: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            url: String,
-            actions:
-              T.nilable(
-                T::Array[
-                  T.any(
-                    ContextDev::WebWebScrapeImagesParams::Action::Wait,
-                    ContextDev::WebWebScrapeImagesParams::Action::Perform,
-                    ContextDev::WebWebScrapeImagesParams::Action::Scroll
-                  )
-                ]
-              ),
-            dedupe: T::Boolean,
-            enrichment:
-              T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment),
-            headers: T::Hash[Symbol, String],
-            max_age_ms: T.nilable(Integer),
-            tags: T::Array[String],
-            timeout_opts: ContextDev::WebWebScrapeImagesParams::TimeoutOpts,
-            wait_for_ms: T.nilable(Integer),
-            zdr: ContextDev::WebWebScrapeImagesParams::Zdr::OrSymbol,
-            request_options: ContextDev::RequestOptions
-          }
-        )
-      end
-      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,
-              ContextDev::WebWebScrapeImagesParams::Action::Scroll
-            )
-          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
-
-        class Scroll < ContextDev::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll,
-                ContextDev::Internal::AnyHash
-              )
-            end
-
-          sig { returns(Symbol) }
-          attr_accessor :do_
-
-          # Pixels per scroll, one visible viewport, or the current scroll boundary.
-          # Defaults to viewport.
-          sig do
-            returns(
-              T.nilable(
-                T.any(
-                  Integer,
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount::OrSymbol
-                )
-              )
-            )
-          end
-          attr_reader :amount
-
-          sig do
-            params(
-              amount:
-                T.any(
-                  Integer,
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount::OrSymbol
-                )
-            ).void
-          end
-          attr_writer :amount
-
-          # CSS selector for the first matching scroll container. Defaults to the page.
-          sig { returns(T.nilable(String)) }
-          attr_reader :container
-
-          sig { params(container: String).void }
-          attr_writer :container
-
-          # Direction to scroll. Defaults to down.
-          sig do
-            returns(
-              T.nilable(
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::OrSymbol
-              )
-            )
-          end
-          attr_reader :direction
-
-          sig do
-            params(
-              direction:
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::OrSymbol
-            ).void
-          end
-          attr_writer :direction
-
-          # Maximum scroll iterations. Stops early when scrolling and scrollable extent stop
-          # changing. Defaults to 1.
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :max_scrolls
-
-          sig { params(max_scrolls: Integer).void }
-          attr_writer :max_scrolls
-
-          # Scroll the page or a selected scrollable container, waiting adaptively for
-          # content and dimensions to settle after each iteration.
-          sig do
-            params(
-              amount:
-                T.any(
-                  Integer,
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount::OrSymbol
-                ),
-              container: String,
-              direction:
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::OrSymbol,
-              max_scrolls: Integer,
-              do_: Symbol
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Pixels per scroll, one visible viewport, or the current scroll boundary.
-            # Defaults to viewport.
-            amount: nil,
-            # CSS selector for the first matching scroll container. Defaults to the page.
-            container: nil,
-            # Direction to scroll. Defaults to down.
-            direction: nil,
-            # Maximum scroll iterations. Stops early when scrolling and scrollable extent stop
-            # changing. Defaults to 1.
-            max_scrolls: nil,
-            do_: :scroll
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                do_: Symbol,
-                amount:
-                  T.any(
-                    Integer,
-                    ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount::OrSymbol
-                  ),
-                container: String,
-                direction:
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::OrSymbol,
-                max_scrolls: Integer
-              }
-            )
-          end
-          def to_hash
-          end
-
-          # Pixels per scroll, one visible viewport, or the current scroll boundary.
-          # Defaults to viewport.
-          module Amount
-            extend ContextDev::Internal::Type::Union
-
-            Variants =
-              T.type_alias do
-                T.any(
-                  Integer,
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount::TaggedSymbol
-                )
-              end
-
-            sig do
-              override.returns(
-                T::Array[
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount::Variants
-                ]
-              )
-            end
-            def self.variants
-            end
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            VIEWPORT =
-              T.let(
-                :viewport,
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount::TaggedSymbol
-              )
-            MAX =
-              T.let(
-                :max,
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Amount::TaggedSymbol
-              )
-          end
-
-          # Direction to scroll. Defaults to down.
-          module Direction
-            extend ContextDev::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            UP =
-              T.let(
-                :up,
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::TaggedSymbol
-              )
-            DOWN =
-              T.let(
-                :down,
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::TaggedSymbol
-              )
-            LEFT =
-              T.let(
-                :left,
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::TaggedSymbol
-              )
-            RIGHT =
-              T.let(
-                :right,
-                ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::Direction::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
-        sig do
-          override.returns(
-            T::Array[ContextDev::WebWebScrapeImagesParams::Action::Variants]
-          )
-        end
-        def self.variants
-        end
-      end
-
-      class Enrichment < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::WebWebScrapeImagesParams::Enrichment,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Classify each image by visual asset type.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :classification
-
-        sig { params(classification: T::Boolean).void }
-        attr_writer :classification
-
-        # Host materializable images on the Brand.dev CDN and return their URL and MIME
-        # type. Ignored when zero data retention is enabled.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :hosted_url
-
-        sig { params(hosted_url: T::Boolean).void }
-        attr_writer :hosted_url
-
-        # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :max_time_per_ms
-
-        sig { params(max_time_per_ms: Integer).void }
-        attr_writer :max_time_per_ms
-
-        # Measure image width and height when possible.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :resolution
-
-        sig { params(resolution: T::Boolean).void }
-        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,
-            max_time_per_ms: Integer,
-            resolution: T::Boolean
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Classify each image by visual asset type.
-          classification: nil,
-          # Host materializable images on the Brand.dev CDN and return their URL and MIME
-          # type. Ignored when zero data retention is enabled.
-          hosted_url: nil,
-          # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.
-          max_time_per_ms: nil,
-          # Measure image width and height when possible.
-          resolution: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              classification: T::Boolean,
-              hosted_url: T::Boolean,
-              max_time_per_ms: Integer,
-              resolution: T::Boolean
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::WebWebScrapeImagesParams::TimeoutOpts,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-        sig { returns(Integer) }
-        attr_accessor :milliseconds
-
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results. "return-partial" requires milliseconds of at
-        # least 5000.
-        sig do
-          returns(
-            T.nilable(
-              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::OrSymbol
-            )
-          )
-        end
-        attr_reader :behavior
-
-        sig do
-          params(
-            behavior:
-              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::OrSymbol
-          ).void
-        end
-        attr_writer :behavior
-
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
-        sig do
-          params(
-            milliseconds: Integer,
-            behavior:
-              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-          milliseconds:,
-          # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-          # credits. "return-partial" returns usable results collected so far; if none are
-          # available, the request still fails without charging credits. Partial results are
-          # not cached as complete results. "return-partial" requires milliseconds of at
-          # least 5000.
-          behavior: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              milliseconds: Integer,
-              behavior:
-                ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results. "return-partial" requires milliseconds of at
-        # least 5000.
-        module Behavior
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          FAIL =
-            T.let(
-              :fail,
-              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::TaggedSymbol
-            )
-          RETURN_PARTIAL =
-            T.let(
-              :"return-partial",
-              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
-      module Zdr
-        extend ContextDev::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, ContextDev::WebWebScrapeImagesParams::Zdr)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        ENABLED =
-          T.let(
-            :enabled,
-            ContextDev::WebWebScrapeImagesParams::Zdr::TaggedSymbol
-          )
-        DISABLED =
-          T.let(
-            :disabled,
-            ContextDev::WebWebScrapeImagesParams::Zdr::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[ContextDev::WebWebScrapeImagesParams::Zdr::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end