context.dev 2.18.0 → 2.20.0

data/lib/context_dev/models/web_web_scrape_sitemap_response.rb

@@ -1,144 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::Web#web_scrape_sitemap
-    class WebWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel
-      # @!attribute domain
-      #   The normalized domain that was crawled
-      #
-      #   @return [String]
-      required :domain, String
-
-      # @!attribute meta
-      #   Metadata about the sitemap crawl operation
-      #
-      #   @return [ContextDev::Models::WebWebScrapeSitemapResponse::Meta]
-      required :meta, -> { ContextDev::Models::WebWebScrapeSitemapResponse::Meta }
-
-      # @!attribute request_id
-      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #   it when contacting support about a failed request.
-      #
-      #   @return [String]
-      required :request_id, String
-
-      # @!attribute success
-      #   Indicates success
-      #
-      #   @return [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success]
-      required :success, enum: -> { ContextDev::Models::WebWebScrapeSitemapResponse::Success }
-
-      # @!attribute urls
-      #   Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set
-      #   these are only the matching pages, most relevant first.
-      #
-      #   @return [Array<String>]
-      required :urls, ContextDev::Internal::Type::ArrayOf[String]
-
-      # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
-      #
-      #   @return [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, nil]
-      optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata }
-
-      # @!attribute partial
-      #   True when timeoutOpts.behavior=return-partial returned the usable results
-      #   collected before the deadline. Partial collections are not cached as complete
-      #   results.
-      #
-      #   @return [Boolean, nil]
-      optional :partial, ContextDev::Internal::Type::Boolean
-
-      # @!method initialize(domain:, meta:, request_id:, success:, urls:, key_metadata: nil, partial: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::WebWebScrapeSitemapResponse} for more details.
-      #
-      #   @param domain [String] The normalized domain that was crawled
-      #
-      #   @param meta [ContextDev::Models::WebWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation
-      #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #
-      #   @param success [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success] Indicates success
-      #
-      #   @param urls [Array<String>] Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set th
-      #
-      #   @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
-      #
-      #   @param partial [Boolean] True when timeoutOpts.behavior=return-partial returned the usable results collec
-
-      # @see ContextDev::Models::WebWebScrapeSitemapResponse#meta
-      class Meta < ContextDev::Internal::Type::BaseModel
-        # @!attribute errors
-        #   Number of errors encountered during crawling
-        #
-        #   @return [Integer]
-        required :errors, Integer
-
-        # @!attribute sitemaps_discovered
-        #   Total number of sitemap files discovered
-        #
-        #   @return [Integer]
-        required :sitemaps_discovered, Integer, api_name: :sitemapsDiscovered
-
-        # @!attribute sitemaps_fetched
-        #   Number of sitemap files successfully fetched and parsed
-        #
-        #   @return [Integer]
-        required :sitemaps_fetched, Integer, api_name: :sitemapsFetched
-
-        # @!attribute sitemaps_skipped
-        #   Number of sitemap files skipped (due to errors, timeouts, or limits)
-        #
-        #   @return [Integer]
-        required :sitemaps_skipped, Integer, api_name: :sitemapsSkipped
-
-        # @!method initialize(errors:, sitemaps_discovered:, sitemaps_fetched:, sitemaps_skipped:)
-        #   Metadata about the sitemap crawl operation
-        #
-        #   @param errors [Integer] Number of errors encountered during crawling
-        #
-        #   @param sitemaps_discovered [Integer] Total number of sitemap files discovered
-        #
-        #   @param sitemaps_fetched [Integer] Number of sitemap files successfully fetched and parsed
-        #
-        #   @param sitemaps_skipped [Integer] Number of sitemap files skipped (due to errors, timeouts, or limits)
-      end
-
-      # Indicates success
-      #
-      # @see ContextDev::Models::WebWebScrapeSitemapResponse#success
-      module Success
-        extend ContextDev::Internal::Type::Enum
-
-        TRUE = true
-
-        # @!method self.values
-        #   @return [Array<Boolean>]
-      end
-
-      # @see ContextDev::Models::WebWebScrapeSitemapResponse#key_metadata
-      class KeyMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute credits_consumed
-        #   Credits used by this request.
-        #
-        #   @return [Integer]
-        required :credits_consumed, Integer
-
-        # @!attribute credits_remaining
-        #   Credits remaining for your organization.
-        #
-        #   @return [Integer]
-        required :credits_remaining, Integer
-
-        # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
-        #
-        #   @param credits_consumed [Integer] Credits used by this request.
-        #
-        #   @param credits_remaining [Integer] Credits remaining for your organization.
-      end
-    end
-  end
-end

data/lib/context_dev/resources/ai.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Resources
-    class AI
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::AIExtractProductParams} for more details.
-      #
-      # Given a single URL, determines if it is a product page and extracts the product
-      # information.
-      #
-      # @overload extract_product(url:, max_age_ms: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
-      #
-      # @param url [String] The product page URL to extract product data from.
-      #
-      # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y
-      #
-      # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
-      #
-      # @param timeout_opts [ContextDev::Models::AIExtractProductParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
-      #
-      # @param zdr [Symbol, ContextDev::Models::AIExtractProductParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::AIExtractProductResponse]
-      #
-      # @see ContextDev::Models::AIExtractProductParams
-      def extract_product(params)
-        parsed, options = ContextDev::AIExtractProductParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "brand/ai/product",
-          body: parsed,
-          model: ContextDev::Models::AIExtractProductResponse,
-          options: 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.
-      #
-      # @overload extract_products(body:, request_options: {})
-      #
-      # @param body [ContextDev::Models::AIExtractProductsParams::Body::ByDomain, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL]
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::AIExtractProductsResponse]
-      #
-      # @see ContextDev::Models::AIExtractProductsParams
-      def extract_products(params)
-        parsed, options = ContextDev::AIExtractProductsParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "brand/ai/products",
-          body: parsed[:body],
-          model: ContextDev::Models::AIExtractProductsResponse,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [ContextDev::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/context_dev/models/ai_extract_product_params.rbi

@@ -1,253 +0,0 @@
-# typed: strong
-
-module ContextDev
-  module Models
-    class AIExtractProductParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            ContextDev::AIExtractProductParams,
-            ContextDev::Internal::AnyHash
-          )
-        end
-
-      # The product page URL to extract product data from.
-      sig { returns(String) }
-      attr_accessor :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.
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :max_age_ms
-
-      sig { params(max_age_ms: Integer).void }
-      attr_writer :max_age_ms
-
-      # Optional tags for tracking usage. Up to 20 tags, each 1 to 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::AIExtractProductParams::TimeoutOpts))
-      end
-      attr_reader :timeout_opts
-
-      sig do
-        params(
-          timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts::OrHash
-        ).void
-      end
-      attr_writer :timeout_opts
-
-      # 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::AIExtractProductParams::Zdr::OrSymbol))
-      end
-      attr_reader :zdr
-
-      sig do
-        params(zdr: ContextDev::AIExtractProductParams::Zdr::OrSymbol).void
-      end
-      attr_writer :zdr
-
-      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(T.attached_class)
-      end
-      def self.new(
-        # 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
-
-      sig do
-        override.returns(
-          {
-            url: String,
-            max_age_ms: Integer,
-            tags: T::Array[String],
-            timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts,
-            zdr: ContextDev::AIExtractProductParams::Zdr::OrSymbol,
-            request_options: ContextDev::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::AIExtractProductParams::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.
-        sig do
-          returns(
-            T.nilable(
-              ContextDev::AIExtractProductParams::TimeoutOpts::Behavior::OrSymbol
-            )
-          )
-        end
-        attr_reader :behavior
-
-        sig do
-          params(
-            behavior:
-              ContextDev::AIExtractProductParams::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::AIExtractProductParams::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.
-          behavior: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              milliseconds: Integer,
-              behavior:
-                ContextDev::AIExtractProductParams::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.
-        module Behavior
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::AIExtractProductParams::TimeoutOpts::Behavior
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          FAIL =
-            T.let(
-              :fail,
-              ContextDev::AIExtractProductParams::TimeoutOpts::Behavior::TaggedSymbol
-            )
-          RETURN_PARTIAL =
-            T.let(
-              :"return-partial",
-              ContextDev::AIExtractProductParams::TimeoutOpts::Behavior::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::AIExtractProductParams::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::AIExtractProductParams::Zdr)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        ENABLED =
-          T.let(:enabled, ContextDev::AIExtractProductParams::Zdr::TaggedSymbol)
-        DISABLED =
-          T.let(
-            :disabled,
-            ContextDev::AIExtractProductParams::Zdr::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[ContextDev::AIExtractProductParams::Zdr::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end