context.dev 0.0.2

data/lib/context_dev/models/brand_web_scrape_html_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#web_scrape_html
+    class BrandWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   Full URL to scrape (must include http:// or https:// protocol)
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(url:, request_options: {})
+      #   @param url [String] Full URL to scrape (must include http:// or https:// protocol)
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/brand_web_scrape_html_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#web_scrape_html
+    class BrandWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute html
+      #   Raw HTML content of the page
+      #
+      #   @return [String]
+      required :html, String
+
+      # @!attribute success
+      #   Indicates success
+      #
+      #   @return [Boolean, ContextDev::Models::BrandWebScrapeHTMLResponse::Success]
+      required :success, enum: -> { ContextDev::Models::BrandWebScrapeHTMLResponse::Success }
+
+      # @!attribute url
+      #   The URL that was scraped
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(html:, success:, url:)
+      #   @param html [String] Raw HTML content of the page
+      #
+      #   @param success [Boolean, ContextDev::Models::BrandWebScrapeHTMLResponse::Success] Indicates success
+      #
+      #   @param url [String] The URL that was scraped
+
+      # Indicates success
+      #
+      # @see ContextDev::Models::BrandWebScrapeHTMLResponse#success
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/context_dev/models/brand_web_scrape_images_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#web_scrape_images
+    class BrandWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   Full URL to scrape images from (must include http:// or https:// protocol)
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(url:, request_options: {})
+      #   @param url [String] Full URL to scrape images from (must include http:// or https:// protocol)
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/brand_web_scrape_images_response.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#web_scrape_images
+    class BrandWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute images
+      #   Array of scraped images
+      #
+      #   @return [Array<ContextDev::Models::BrandWebScrapeImagesResponse::Image>]
+      required :images,
+               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandWebScrapeImagesResponse::Image] }
+
+      # @!attribute success
+      #   Indicates success
+      #
+      #   @return [Boolean, ContextDev::Models::BrandWebScrapeImagesResponse::Success]
+      required :success, enum: -> { ContextDev::Models::BrandWebScrapeImagesResponse::Success }
+
+      # @!attribute url
+      #   The URL that was scraped
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(images:, success:, url:)
+      #   @param images [Array<ContextDev::Models::BrandWebScrapeImagesResponse::Image>] Array of scraped images
+      #
+      #   @param success [Boolean, ContextDev::Models::BrandWebScrapeImagesResponse::Success] Indicates success
+      #
+      #   @param url [String] The URL that was scraped
+
+      class Image < ContextDev::Internal::Type::BaseModel
+        # @!attribute alt
+        #   Alt text of the image, or null if not present
+        #
+        #   @return [String, nil]
+        required :alt, String, nil?: true
+
+        # @!attribute element
+        #   The HTML element the image was found in
+        #
+        #   @return [Symbol, ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element]
+        required :element, enum: -> { ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element }
+
+        # @!attribute src
+        #   The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+        #
+        #   @return [String]
+        required :src, String
+
+        # @!attribute type
+        #   The type/format of the src value
+        #
+        #   @return [Symbol, ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type]
+        required :type, enum: -> { ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type }
+
+        # @!method initialize(alt:, element:, src:, type:)
+        #   @param alt [String, nil] Alt text of the image, or null if not present
+        #
+        #   @param element [Symbol, ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element] The HTML element the image was found in
+        #
+        #   @param src [String] The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
+        #
+        #   @param type [Symbol, ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type] The type/format of the src value
+
+        # The HTML element the image was found in
+        #
+        # @see ContextDev::Models::BrandWebScrapeImagesResponse::Image#element
+        module Element
+          extend ContextDev::Internal::Type::Enum
+
+          IMG = :img
+          SVG = :svg
+          LINK = :link
+          SOURCE = :source
+          VIDEO = :video
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The type/format of the src value
+        #
+        # @see ContextDev::Models::BrandWebScrapeImagesResponse::Image#type
+        module Type
+          extend ContextDev::Internal::Type::Enum
+
+          URL = :url
+          HTML = :html
+          BASE64 = :base64
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Indicates success
+      #
+      # @see ContextDev::Models::BrandWebScrapeImagesResponse#success
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/context_dev/models/brand_web_scrape_md_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#web_scrape_md
+    class BrandWebScrapeMdParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   Full URL to scrape and convert to markdown (must include http:// or https://
+      #   protocol)
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute include_images
+      #   Include image references in Markdown output
+      #
+      #   @return [Boolean, nil]
+      optional :include_images, ContextDev::Internal::Type::Boolean
+
+      # @!attribute include_links
+      #   Preserve hyperlinks in Markdown output
+      #
+      #   @return [Boolean, nil]
+      optional :include_links, ContextDev::Internal::Type::Boolean
+
+      # @!attribute shorten_base64_images
+      #   Shorten base64-encoded image data in the Markdown output
+      #
+      #   @return [Boolean, nil]
+      optional :shorten_base64_images, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BrandWebScrapeMdParams} for more details.
+      #
+      #   @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro
+      #
+      #   @param include_images [Boolean] Include image references in Markdown output
+      #
+      #   @param include_links [Boolean] Preserve hyperlinks in Markdown output
+      #
+      #   @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/brand_web_scrape_md_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#web_scrape_md
+    class BrandWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute markdown
+      #   Page content converted to GitHub Flavored Markdown
+      #
+      #   @return [String]
+      required :markdown, String
+
+      # @!attribute success
+      #   Indicates success
+      #
+      #   @return [Boolean, ContextDev::Models::BrandWebScrapeMdResponse::Success]
+      required :success, enum: -> { ContextDev::Models::BrandWebScrapeMdResponse::Success }
+
+      # @!attribute url
+      #   The URL that was scraped
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(markdown:, success:, url:)
+      #   @param markdown [String] Page content converted to GitHub Flavored Markdown
+      #
+      #   @param success [Boolean, ContextDev::Models::BrandWebScrapeMdResponse::Success] Indicates success
+      #
+      #   @param url [String] The URL that was scraped
+
+      # Indicates success
+      #
+      # @see ContextDev::Models::BrandWebScrapeMdResponse#success
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/context_dev/models/brand_web_scrape_sitemap_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#web_scrape_sitemap
+    class BrandWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
+      #   automatically normalized and validated.
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!method initialize(domain:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BrandWebScrapeSitemapParams} for more details.
+      #
+      #   @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/brand_web_scrape_sitemap_response.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#web_scrape_sitemap
+    class BrandWebScrapeSitemapResponse < 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::BrandWebScrapeSitemapResponse::Meta]
+      required :meta, -> { ContextDev::Models::BrandWebScrapeSitemapResponse::Meta }
+
+      # @!attribute success
+      #   Indicates success
+      #
+      #   @return [Boolean, ContextDev::Models::BrandWebScrapeSitemapResponse::Success]
+      required :success, enum: -> { ContextDev::Models::BrandWebScrapeSitemapResponse::Success }
+
+      # @!attribute urls
+      #   Array of discovered page URLs from the sitemap (max 500)
+      #
+      #   @return [Array<String>]
+      required :urls, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(domain:, meta:, success:, urls:)
+      #   @param domain [String] The normalized domain that was crawled
+      #
+      #   @param meta [ContextDev::Models::BrandWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation
+      #
+      #   @param success [Boolean, ContextDev::Models::BrandWebScrapeSitemapResponse::Success] Indicates success
+      #
+      #   @param urls [Array<String>] Array of discovered page URLs from the sitemap (max 500)
+
+      # @see ContextDev::Models::BrandWebScrapeSitemapResponse#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::BrandWebScrapeSitemapResponse#success
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/context_dev/models.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ContextDev
+  [ContextDev::Internal::Type::BaseModel, *ContextDev::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, ContextDev::Internal::AnyHash) } }
+  end
+
+  ContextDev::Internal::Util.walk_namespaces(ContextDev::Models).each do |mod|
+    case mod
+    in ContextDev::Internal::Type::Enum | ContextDev::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  ContextDev::Internal::Util.walk_namespaces(ContextDev::Models)
+                            .lazy
+                            .grep(ContextDev::Internal::Type::Union)
+                            .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  BrandAIProductParams = ContextDev::Models::BrandAIProductParams
+
+  BrandAIProductsParams = ContextDev::Models::BrandAIProductsParams
+
+  BrandAIQueryParams = ContextDev::Models::BrandAIQueryParams
+
+  BrandFontsParams = ContextDev::Models::BrandFontsParams
+
+  BrandIdentifyFromTransactionParams = ContextDev::Models::BrandIdentifyFromTransactionParams
+
+  BrandPrefetchByEmailParams = ContextDev::Models::BrandPrefetchByEmailParams
+
+  BrandPrefetchParams = ContextDev::Models::BrandPrefetchParams
+
+  BrandRetrieveByEmailParams = ContextDev::Models::BrandRetrieveByEmailParams
+
+  BrandRetrieveByIsinParams = ContextDev::Models::BrandRetrieveByIsinParams
+
+  BrandRetrieveByNameParams = ContextDev::Models::BrandRetrieveByNameParams
+
+  BrandRetrieveByTickerParams = ContextDev::Models::BrandRetrieveByTickerParams
+
+  BrandRetrieveNaicsParams = ContextDev::Models::BrandRetrieveNaicsParams
+
+  BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
+
+  BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
+
+  BrandScreenshotParams = ContextDev::Models::BrandScreenshotParams
+
+  BrandStyleguideParams = ContextDev::Models::BrandStyleguideParams
+
+  BrandWebScrapeHTMLParams = ContextDev::Models::BrandWebScrapeHTMLParams
+
+  BrandWebScrapeImagesParams = ContextDev::Models::BrandWebScrapeImagesParams
+
+  BrandWebScrapeMdParams = ContextDev::Models::BrandWebScrapeMdParams
+
+  BrandWebScrapeSitemapParams = ContextDev::Models::BrandWebScrapeSitemapParams
+end

data/lib/context_dev/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ContextDev
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < ContextDev::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in ContextDev::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, ContextDev::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(ContextDev::RequestOptions, ContextDev::Internal::AnyHash) }
+    end
+  end
+end