context.dev 2.17.1 → 2.19.0

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,56 +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,
-          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,
-        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

data/sig/context_dev/models/ai_extract_product_params.rbs

@@ -1,86 +0,0 @@
-module ContextDev
-  module Models
-    type ai_extract_product_params =
-      {
-        url: String,
-        max_age_ms: Integer,
-        tags: ::Array[String],
-        timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts
-      }
-      & ContextDev::Internal::Type::request_parameters
-
-    class AIExtractProductParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      attr_accessor url: String
-
-      attr_reader max_age_ms: Integer?
-
-      def max_age_ms=: (Integer) -> Integer
-
-      attr_reader tags: ::Array[String]?
-
-      def tags=: (::Array[String]) -> ::Array[String]
-
-      attr_reader timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts?
-
-      def timeout_opts=: (
-        ContextDev::AIExtractProductParams::TimeoutOpts
-      ) -> ContextDev::AIExtractProductParams::TimeoutOpts
-
-      def initialize: (
-        url: String,
-        ?max_age_ms: Integer,
-        ?tags: ::Array[String],
-        ?timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts,
-        ?request_options: ContextDev::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        url: String,
-        max_age_ms: Integer,
-        tags: ::Array[String],
-        timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts,
-        request_options: ContextDev::RequestOptions
-      }
-
-      type timeout_opts =
-        {
-          milliseconds: Integer,
-          behavior: ContextDev::Models::AIExtractProductParams::TimeoutOpts::behavior
-        }
-
-      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
-        attr_accessor milliseconds: Integer
-
-        attr_reader behavior: ContextDev::Models::AIExtractProductParams::TimeoutOpts::behavior?
-
-        def behavior=: (
-          ContextDev::Models::AIExtractProductParams::TimeoutOpts::behavior
-        ) -> ContextDev::Models::AIExtractProductParams::TimeoutOpts::behavior
-
-        def initialize: (
-          milliseconds: Integer,
-          ?behavior: ContextDev::Models::AIExtractProductParams::TimeoutOpts::behavior
-        ) -> void
-
-        def to_hash: -> {
-          milliseconds: Integer,
-          behavior: ContextDev::Models::AIExtractProductParams::TimeoutOpts::behavior
-        }
-
-        type behavior = :fail | :"return-partial"
-
-        module Behavior
-          extend ContextDev::Internal::Type::Enum
-
-          FAIL: :fail
-          RETURN_PARTIAL: :"return-partial"
-
-          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductParams::TimeoutOpts::behavior]
-        end
-      end
-    end
-  end
-end

data/sig/context_dev/models/ai_extract_product_response.rbs

@@ -1,273 +0,0 @@
-module ContextDev
-  module Models
-    type ai_extract_product_response =
-      {
-        cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata,
-        request_id: String,
-        is_product_page: bool,
-        key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
-        partial: bool,
-        platform: ContextDev::Models::AIExtractProductResponse::platform?,
-        product: ContextDev::Models::AIExtractProductResponse::Product?
-      }
-
-    class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel
-      attr_accessor cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata
-
-      attr_accessor request_id: String
-
-      attr_reader is_product_page: bool?
-
-      def is_product_page=: (bool) -> bool
-
-      attr_reader key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata?
-
-      def key_metadata=: (
-        ContextDev::Models::AIExtractProductResponse::KeyMetadata
-      ) -> ContextDev::Models::AIExtractProductResponse::KeyMetadata
-
-      attr_reader partial: bool?
-
-      def partial=: (bool) -> bool
-
-      attr_accessor platform: ContextDev::Models::AIExtractProductResponse::platform?
-
-      attr_accessor product: ContextDev::Models::AIExtractProductResponse::Product?
-
-      def initialize: (
-        cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata,
-        request_id: String,
-        ?is_product_page: bool,
-        ?key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
-        ?partial: bool,
-        ?platform: ContextDev::Models::AIExtractProductResponse::platform?,
-        ?product: ContextDev::Models::AIExtractProductResponse::Product?
-      ) -> void
-
-      def to_hash: -> {
-        cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata,
-        request_id: String,
-        is_product_page: bool,
-        key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
-        partial: bool,
-        platform: ContextDev::Models::AIExtractProductResponse::platform?,
-        product: ContextDev::Models::AIExtractProductResponse::Product?
-      }
-
-      type cache_metadata =
-        {
-          age_ms: Integer,
-          status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status
-        }
-
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        attr_accessor age_ms: Integer
-
-        attr_accessor status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status
-
-        def initialize: (
-          age_ms: Integer,
-          status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status
-        ) -> void
-
-        def to_hash: -> {
-          age_ms: Integer,
-          status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status
-        }
-
-        type status = :hit | :miss | :zdr
-
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT: :hit
-          MISS: :miss
-          ZDR: :zdr
-
-          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::CacheMetadata::status]
-        end
-      end
-
-      type key_metadata =
-        { credits_consumed: Integer, credits_remaining: Integer }
-
-      class KeyMetadata < ContextDev::Internal::Type::BaseModel
-        attr_accessor credits_consumed: Integer
-
-        attr_accessor credits_remaining: Integer
-
-        def initialize: (
-          credits_consumed: Integer,
-          credits_remaining: Integer
-        ) -> void
-
-        def to_hash: -> {
-          credits_consumed: Integer,
-          credits_remaining: Integer
-        }
-      end
-
-      type platform = :amazon | :tiktok_shop | :etsy | :generic
-
-      module Platform
-        extend ContextDev::Internal::Type::Enum
-
-        AMAZON: :amazon
-        TIKTOK_SHOP: :tiktok_shop
-        ETSY: :etsy
-        GENERIC: :generic
-
-        def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::platform]
-      end
-
-      type product =
-        {
-          description: String,
-          features: ::Array[String],
-          images: ::Array[String],
-          name: String,
-          sku: String?,
-          tags: ::Array[String],
-          target_audience: ::Array[String],
-          availability: ContextDev::Models::AIExtractProductResponse::Product::availability?,
-          billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?,
-          category: String?,
-          currency: String?,
-          dimensions: ::Array[String],
-          image_url: String?,
-          price: Float?,
-          pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?,
-          regular_price: Float?,
-          url: String?
-        }
-
-      class Product < ContextDev::Internal::Type::BaseModel
-        attr_accessor description: String
-
-        attr_accessor features: ::Array[String]
-
-        attr_accessor images: ::Array[String]
-
-        attr_accessor name: String
-
-        attr_accessor sku: String?
-
-        attr_accessor tags: ::Array[String]
-
-        attr_accessor target_audience: ::Array[String]
-
-        attr_accessor availability: ContextDev::Models::AIExtractProductResponse::Product::availability?
-
-        attr_accessor billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?
-
-        attr_accessor category: String?
-
-        attr_accessor currency: String?
-
-        attr_reader dimensions: ::Array[String]?
-
-        def dimensions=: (::Array[String]) -> ::Array[String]
-
-        attr_accessor image_url: String?
-
-        attr_accessor price: Float?
-
-        attr_accessor pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?
-
-        attr_accessor regular_price: Float?
-
-        attr_accessor url: String?
-
-        def initialize: (
-          description: String,
-          features: ::Array[String],
-          images: ::Array[String],
-          name: String,
-          sku: String?,
-          tags: ::Array[String],
-          target_audience: ::Array[String],
-          ?availability: ContextDev::Models::AIExtractProductResponse::Product::availability?,
-          ?billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?,
-          ?category: String?,
-          ?currency: String?,
-          ?dimensions: ::Array[String],
-          ?image_url: String?,
-          ?price: Float?,
-          ?pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?,
-          ?regular_price: Float?,
-          ?url: String?
-        ) -> void
-
-        def to_hash: -> {
-          description: String,
-          features: ::Array[String],
-          images: ::Array[String],
-          name: String,
-          sku: String?,
-          tags: ::Array[String],
-          target_audience: ::Array[String],
-          availability: ContextDev::Models::AIExtractProductResponse::Product::availability?,
-          billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?,
-          category: String?,
-          currency: String?,
-          dimensions: ::Array[String],
-          image_url: String?,
-          price: Float?,
-          pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?,
-          regular_price: Float?,
-          url: String?
-        }
-
-        type availability =
-          :in_stock
-          | :out_of_stock
-          | :limited_availability
-          | :preorder
-          | :backorder
-          | :made_to_order
-          | :discontinued
-
-        module Availability
-          extend ContextDev::Internal::Type::Enum
-
-          IN_STOCK: :in_stock
-          OUT_OF_STOCK: :out_of_stock
-          LIMITED_AVAILABILITY: :limited_availability
-          PREORDER: :preorder
-          BACKORDER: :backorder
-          MADE_TO_ORDER: :made_to_order
-          DISCONTINUED: :discontinued
-
-          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::Product::availability]
-        end
-
-        type billing_frequency = :monthly | :yearly | :one_time | :usage_based
-
-        module BillingFrequency
-          extend ContextDev::Internal::Type::Enum
-
-          MONTHLY: :monthly
-          YEARLY: :yearly
-          ONE_TIME: :one_time
-          USAGE_BASED: :usage_based
-
-          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::Product::billing_frequency]
-        end
-
-        type pricing_model = :per_seat | :flat | :tiered | :freemium | :custom
-
-        module PricingModel
-          extend ContextDev::Internal::Type::Enum
-
-          PER_SEAT: :per_seat
-          FLAT: :flat
-          TIERED: :tiered
-          FREEMIUM: :freemium
-          CUSTOM: :custom
-
-          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::Product::pricing_model]
-        end
-      end
-    end
-  end
-end