context.dev 2.18.0 → 2.19.0

data/rbi/context_dev/models/web_web_scrape_screenshot_response.rbi

@@ -1,332 +0,0 @@
-# typed: strong
-
-module ContextDev
-  module Models
-    class WebWebScrapeScreenshotResponse < ContextDev::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            ContextDev::Models::WebWebScrapeScreenshotResponse,
-            ContextDev::Internal::AnyHash
-          )
-        end
-
-      # Cache outcome for this response. Composite responses are hits only when every
-      # cache-controlled fetch contributing to the output was a hit; age_ms is the
-      # oldest contributing hit.
-      sig do
-        returns(
-          ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata
-        )
-      end
-      attr_reader :cache_metadata
-
-      sig do
-        params(
-          cache_metadata:
-            ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::OrHash
-        ).void
-      end
-      attr_writer :cache_metadata
-
-      # Height of the returned image in pixels.
-      sig { returns(Integer) }
-      attr_accessor :height
-
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
-      sig { returns(String) }
-      attr_accessor :request_id
-
-      # Public image URL for standard requests, or an in-memory data URL when ZDR is
-      # enabled.
-      sig { returns(String) }
-      attr_accessor :screenshot
-
-      # The requested page URL.
-      sig { returns(String) }
-      attr_accessor :url
-
-      # Width of the returned image in pixels.
-      sig { returns(Integer) }
-      attr_accessor :width
-
-      # How complete the returned content is. `loaded` means the page finished the waits
-      # the request asked for. `still-loading` only occurs with
-      # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-      # reached first, so the content reflects the DOM at that moment and late-rendering
-      # parts may be missing. Partial results are billed at the base request cost.
-      sig do
-        returns(
-          T.nilable(
-            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol
-          )
-        )
-      end
-      attr_reader :final_dom_state
-
-      sig do
-        params(
-          final_dom_state:
-            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::OrSymbol
-        ).void
-      end
-      attr_writer :final_dom_state
-
-      # Credit usage, included whenever a valid API key is provided.
-      sig do
-        returns(
-          T.nilable(
-            ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata
-          )
-        )
-      end
-      attr_reader :key_metadata
-
-      sig do
-        params(
-          key_metadata:
-            ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata::OrHash
-        ).void
-      end
-      attr_writer :key_metadata
-
-      sig do
-        params(
-          cache_metadata:
-            ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::OrHash,
-          height: Integer,
-          request_id: String,
-          screenshot: String,
-          url: String,
-          width: Integer,
-          final_dom_state:
-            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::OrSymbol,
-          key_metadata:
-            ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Cache outcome for this response. Composite responses are hits only when every
-        # cache-controlled fetch contributing to the output was a hit; age_ms is the
-        # oldest contributing hit.
-        cache_metadata:,
-        # Height of the returned image in pixels.
-        height:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
-        request_id:,
-        # Public image URL for standard requests, or an in-memory data URL when ZDR is
-        # enabled.
-        screenshot:,
-        # The requested page URL.
-        url:,
-        # Width of the returned image in pixels.
-        width:,
-        # How complete the returned content is. `loaded` means the page finished the waits
-        # the request asked for. `still-loading` only occurs with
-        # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-        # reached first, so the content reflects the DOM at that moment and late-rendering
-        # parts may be missing. Partial results are billed at the base request cost.
-        final_dom_state: nil,
-        # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            cache_metadata:
-              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata,
-            height: Integer,
-            request_id: String,
-            screenshot: String,
-            url: String,
-            width: Integer,
-            final_dom_state:
-              ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol,
-            key_metadata:
-              ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        sig { returns(Integer) }
-        attr_accessor :age_ms
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        sig do
-          returns(
-            ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
-          )
-        end
-        attr_accessor :status
-
-        # Cache outcome for this response. Composite responses are hits only when every
-        # cache-controlled fetch contributing to the output was a hit; age_ms is the
-        # oldest contributing hit.
-        sig do
-          params(
-            age_ms: Integer,
-            status:
-              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Age of the cached data in milliseconds. Zero for miss and zdr responses.
-          age_ms:,
-          # Whether the response was served from cache, required fresh work, or honored
-          # zero-data-retention cache bypass.
-          status:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              age_ms: Integer,
-              status:
-                ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          HIT =
-            T.let(
-              :hit,
-              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
-            )
-          MISS =
-            T.let(
-              :miss,
-              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
-            )
-          ZDR =
-            T.let(
-              :zdr,
-              ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
-      # How complete the returned content is. `loaded` means the page finished the waits
-      # the request asked for. `still-loading` only occurs with
-      # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-      # reached first, so the content reflects the DOM at that moment and late-rendering
-      # parts may be missing. Partial results are billed at the base request cost.
-      module FinalDomState
-        extend ContextDev::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        LOADED =
-          T.let(
-            :loaded,
-            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol
-          )
-        STILL_LOADING =
-          T.let(
-            :"still-loading",
-            ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      class KeyMetadata < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Credits used by this request.
-        sig { returns(Integer) }
-        attr_accessor :credits_consumed
-
-        # Credits remaining for your organization.
-        sig { returns(Integer) }
-        attr_accessor :credits_remaining
-
-        # Credit usage, included whenever a valid API key is provided.
-        sig do
-          params(credits_consumed: Integer, credits_remaining: Integer).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Credits used by this request.
-          credits_consumed:,
-          # Credits remaining for your organization.
-          credits_remaining:
-        )
-        end
-
-        sig do
-          override.returns(
-            { credits_consumed: Integer, credits_remaining: Integer }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi

@@ -1,258 +0,0 @@
-# typed: strong
-
-module ContextDev
-  module Models
-    class WebWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            ContextDev::Models::WebWebScrapeSitemapResponse,
-            ContextDev::Internal::AnyHash
-          )
-        end
-
-      # The normalized domain that was crawled
-      sig { returns(String) }
-      attr_accessor :domain
-
-      # Metadata about the sitemap crawl operation
-      sig { returns(ContextDev::Models::WebWebScrapeSitemapResponse::Meta) }
-      attr_reader :meta
-
-      sig do
-        params(
-          meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash
-        ).void
-      end
-      attr_writer :meta
-
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
-      sig { returns(String) }
-      attr_accessor :request_id
-
-      # Indicates success
-      sig do
-        returns(
-          ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean
-        )
-      end
-      attr_accessor :success
-
-      # Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set
-      # these are only the matching pages, most relevant first.
-      sig { returns(T::Array[String]) }
-      attr_accessor :urls
-
-      # Credit usage, included whenever a valid API key is provided.
-      sig do
-        returns(
-          T.nilable(
-            ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata
-          )
-        )
-      end
-      attr_reader :key_metadata
-
-      sig do
-        params(
-          key_metadata:
-            ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata::OrHash
-        ).void
-      end
-      attr_writer :key_metadata
-
-      # True when timeoutOpts.behavior=return-partial returned the usable results
-      # collected before the deadline. Partial collections are not cached as complete
-      # results.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :partial
-
-      sig { params(partial: T::Boolean).void }
-      attr_writer :partial
-
-      sig do
-        params(
-          domain: String,
-          meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash,
-          request_id: String,
-          success:
-            ContextDev::Models::WebWebScrapeSitemapResponse::Success::OrBoolean,
-          urls: T::Array[String],
-          key_metadata:
-            ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata::OrHash,
-          partial: T::Boolean
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The normalized domain that was crawled
-        domain:,
-        # Metadata about the sitemap crawl operation
-        meta:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
-        request_id:,
-        # Indicates success
-        success:,
-        # Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set
-        # these are only the matching pages, most relevant first.
-        urls:,
-        # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil,
-        # True when timeoutOpts.behavior=return-partial returned the usable results
-        # collected before the deadline. Partial collections are not cached as complete
-        # results.
-        partial: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            domain: String,
-            meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta,
-            request_id: String,
-            success:
-              ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean,
-            urls: T::Array[String],
-            key_metadata:
-              ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata,
-            partial: T::Boolean
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Meta < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::Models::WebWebScrapeSitemapResponse::Meta,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Number of errors encountered during crawling
-        sig { returns(Integer) }
-        attr_accessor :errors
-
-        # Total number of sitemap files discovered
-        sig { returns(Integer) }
-        attr_accessor :sitemaps_discovered
-
-        # Number of sitemap files successfully fetched and parsed
-        sig { returns(Integer) }
-        attr_accessor :sitemaps_fetched
-
-        # Number of sitemap files skipped (due to errors, timeouts, or limits)
-        sig { returns(Integer) }
-        attr_accessor :sitemaps_skipped
-
-        # Metadata about the sitemap crawl operation
-        sig do
-          params(
-            errors: Integer,
-            sitemaps_discovered: Integer,
-            sitemaps_fetched: Integer,
-            sitemaps_skipped: Integer
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Number of errors encountered during crawling
-          errors:,
-          # Total number of sitemap files discovered
-          sitemaps_discovered:,
-          # Number of sitemap files successfully fetched and parsed
-          sitemaps_fetched:,
-          # Number of sitemap files skipped (due to errors, timeouts, or limits)
-          sitemaps_skipped:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              errors: Integer,
-              sitemaps_discovered: Integer,
-              sitemaps_fetched: Integer,
-              sitemaps_skipped: Integer
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      # Indicates success
-      module Success
-        extend ContextDev::Internal::Type::Enum
-
-        TaggedBoolean =
-          T.type_alias do
-            T.all(
-              T::Boolean,
-              ContextDev::Models::WebWebScrapeSitemapResponse::Success
-            )
-          end
-        OrBoolean = T.type_alias { T::Boolean }
-
-        TRUE =
-          T.let(
-            true,
-            ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      class KeyMetadata < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Credits used by this request.
-        sig { returns(Integer) }
-        attr_accessor :credits_consumed
-
-        # Credits remaining for your organization.
-        sig { returns(Integer) }
-        attr_accessor :credits_remaining
-
-        # Credit usage, included whenever a valid API key is provided.
-        sig do
-          params(credits_consumed: Integer, credits_remaining: Integer).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Credits used by this request.
-          credits_consumed:,
-          # Credits remaining for your organization.
-          credits_remaining:
-        )
-        end
-
-        sig do
-          override.returns(
-            { credits_consumed: Integer, credits_remaining: Integer }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/context_dev/resources/ai.rbi

@@ -1,63 +0,0 @@
-# typed: strong
-
-module ContextDev
-  module Resources
-    class AI
-      # Given a single URL, determines if it is a product page and extracts the product
-      # information.
-      sig do
-        params(
-          url: String,
-          max_age_ms: Integer,
-          tags: T::Array[String],
-          timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts::OrHash,
-          zdr: ContextDev::AIExtractProductParams::Zdr::OrSymbol,
-          request_options: ContextDev::RequestOptions::OrHash
-        ).returns(ContextDev::Models::AIExtractProductResponse)
-      end
-      def extract_product(
-        # The product page URL to extract product data from.
-        url:,
-        # Return a cached result if a prior scrape for the same parameters exists and is
-        # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
-        # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
-        max_age_ms: nil,
-        # Optional tags for tracking usage. Up to 20 tags, each 1 to 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,
-        # 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
-
-      # Extract product information from a brand's website. We will analyze the website
-      # and return a list of products with details such as name, description, image,
-      # pricing, features, and more.
-      sig do
-        params(
-          body:
-            T.any(
-              ContextDev::AIExtractProductsParams::Body::ByDomain::OrHash,
-              ContextDev::AIExtractProductsParams::Body::ByDirectURL::OrHash
-            ),
-          request_options: ContextDev::RequestOptions::OrHash
-        ).returns(ContextDev::Models::AIExtractProductsResponse)
-      end
-      def extract_products(body:, request_options: {})
-      end
-
-      # @api private
-      sig { params(client: ContextDev::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end