context.dev 0.0.2

data/lib/context_dev/models/brand_retrieve_simplified_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#retrieve_simplified
+    class BrandRetrieveSimplifiedParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to retrieve simplified brand data for
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute timeout_ms
+      #   Optional timeout in milliseconds for the request. If the request takes longer
+      #   than this value, it will be aborted with a 408 status code. Maximum allowed
+      #   value is 300000ms (5 minutes).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer
+
+      # @!method initialize(domain:, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
+      #
+      #   @param domain [String] Domain name to retrieve simplified brand data for
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/brand_retrieve_simplified_response.rb

@@ -0,0 +1,307 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#retrieve_simplified
+    class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Simplified brand information
+      #
+      #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, nil]
+      optional :brand, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand }
+
+      # @!attribute code
+      #   HTTP status code of the response
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(brand: nil, code: nil, status: nil)
+      #   @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
+      #
+      #   @param code [Integer] HTTP status code of the response
+      #
+      #   @param status [String] Status of the response, e.g., 'ok'
+
+      # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#brand
+      class Brand < ContextDev::Internal::Type::BaseModel
+        # @!attribute backdrops
+        #   An array of backdrop images for the brand
+        #
+        #   @return [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop>, nil]
+        optional :backdrops,
+                 -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop] }
+
+        # @!attribute colors
+        #   An array of brand colors
+        #
+        #   @return [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color>, nil]
+        optional :colors,
+                 -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color] }
+
+        # @!attribute domain
+        #   The domain name of the brand
+        #
+        #   @return [String, nil]
+        optional :domain, String
+
+        # @!attribute logos
+        #   An array of logos associated with the brand
+        #
+        #   @return [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo>, nil]
+        optional :logos,
+                 -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo] }
+
+        # @!attribute title
+        #   The title or name of the brand
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(backdrops: nil, colors: nil, domain: nil, logos: nil, title: nil)
+        #   Simplified brand information
+        #
+        #   @param backdrops [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop>] An array of backdrop images for the brand
+        #
+        #   @param colors [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color>] An array of brand colors
+        #
+        #   @param domain [String] The domain name of the brand
+        #
+        #   @param logos [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo>] An array of logos associated with the brand
+        #
+        #   @param title [String] The title or name of the brand
+
+        class Backdrop < ContextDev::Internal::Type::BaseModel
+          # @!attribute colors
+          #   Array of colors in the backdrop image
+          #
+          #   @return [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color>, nil]
+          optional :colors,
+                   -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color] }
+
+          # @!attribute resolution
+          #   Resolution of the backdrop image
+          #
+          #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution, nil]
+          optional :resolution,
+                   -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution }
+
+          # @!attribute url
+          #   URL of the backdrop image
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(colors: nil, resolution: nil, url: nil)
+          #   @param colors [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color>] Array of colors in the backdrop image
+          #
+          #   @param resolution [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution] Resolution of the backdrop image
+          #
+          #   @param url [String] URL of the backdrop image
+
+          class Color < ContextDev::Internal::Type::BaseModel
+            # @!attribute hex
+            #   Color in hexadecimal format
+            #
+            #   @return [String, nil]
+            optional :hex, String
+
+            # @!attribute name
+            #   Name of the color
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!method initialize(hex: nil, name: nil)
+            #   @param hex [String] Color in hexadecimal format
+            #
+            #   @param name [String] Name of the color
+          end
+
+          # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop#resolution
+          class Resolution < ContextDev::Internal::Type::BaseModel
+            # @!attribute aspect_ratio
+            #   Aspect ratio of the image (width/height)
+            #
+            #   @return [Float, nil]
+            optional :aspect_ratio, Float
+
+            # @!attribute height
+            #   Height of the image in pixels
+            #
+            #   @return [Integer, nil]
+            optional :height, Integer
+
+            # @!attribute width
+            #   Width of the image in pixels
+            #
+            #   @return [Integer, nil]
+            optional :width, Integer
+
+            # @!method initialize(aspect_ratio: nil, height: nil, width: nil)
+            #   Resolution of the backdrop image
+            #
+            #   @param aspect_ratio [Float] Aspect ratio of the image (width/height)
+            #
+            #   @param height [Integer] Height of the image in pixels
+            #
+            #   @param width [Integer] Width of the image in pixels
+          end
+        end
+
+        class Color < ContextDev::Internal::Type::BaseModel
+          # @!attribute hex
+          #   Color in hexadecimal format
+          #
+          #   @return [String, nil]
+          optional :hex, String
+
+          # @!attribute name
+          #   Name of the color
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(hex: nil, name: nil)
+          #   @param hex [String] Color in hexadecimal format
+          #
+          #   @param name [String] Name of the color
+        end
+
+        class Logo < ContextDev::Internal::Type::BaseModel
+          # @!attribute colors
+          #   Array of colors in the logo
+          #
+          #   @return [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color>, nil]
+          optional :colors,
+                   -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color] }
+
+          # @!attribute mode
+          #   Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+          #   best for dark mode, 'has_opaque_background' = can be used for either as image
+          #   has its own background
+          #
+          #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode, nil]
+          optional :mode, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode }
+
+          # @!attribute resolution
+          #   Resolution of the logo image
+          #
+          #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution, nil]
+          optional :resolution, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution }
+
+          # @!attribute type
+          #   Type of the logo based on resolution (e.g., 'icon', 'logo')
+          #
+          #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type, nil]
+          optional :type, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type }
+
+          # @!attribute url
+          #   CDN hosted url of the logo (ready for display)
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(colors: nil, mode: nil, resolution: nil, type: nil, url: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo} for more
+          #   details.
+          #
+          #   @param colors [Array<ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color>] Array of colors in the logo
+          #
+          #   @param mode [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode] Indicates when this logo is best used: 'light' = best for light mode, 'dark' = b
+          #
+          #   @param resolution [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution] Resolution of the logo image
+          #
+          #   @param type [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type] Type of the logo based on resolution (e.g., 'icon', 'logo')
+          #
+          #   @param url [String] CDN hosted url of the logo (ready for display)
+
+          class Color < ContextDev::Internal::Type::BaseModel
+            # @!attribute hex
+            #   Color in hexadecimal format
+            #
+            #   @return [String, nil]
+            optional :hex, String
+
+            # @!attribute name
+            #   Name of the color
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!method initialize(hex: nil, name: nil)
+            #   @param hex [String] Color in hexadecimal format
+            #
+            #   @param name [String] Name of the color
+          end
+
+          # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+          # best for dark mode, 'has_opaque_background' = can be used for either as image
+          # has its own background
+          #
+          # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo#mode
+          module Mode
+            extend ContextDev::Internal::Type::Enum
+
+            LIGHT = :light
+            DARK = :dark
+            HAS_OPAQUE_BACKGROUND = :has_opaque_background
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo#resolution
+          class Resolution < ContextDev::Internal::Type::BaseModel
+            # @!attribute aspect_ratio
+            #   Aspect ratio of the image (width/height)
+            #
+            #   @return [Float, nil]
+            optional :aspect_ratio, Float
+
+            # @!attribute height
+            #   Height of the image in pixels
+            #
+            #   @return [Integer, nil]
+            optional :height, Integer
+
+            # @!attribute width
+            #   Width of the image in pixels
+            #
+            #   @return [Integer, nil]
+            optional :width, Integer
+
+            # @!method initialize(aspect_ratio: nil, height: nil, width: nil)
+            #   Resolution of the logo image
+            #
+            #   @param aspect_ratio [Float] Aspect ratio of the image (width/height)
+            #
+            #   @param height [Integer] Height of the image in pixels
+            #
+            #   @param width [Integer] Width of the image in pixels
+          end
+
+          # Type of the logo based on resolution (e.g., 'icon', 'logo')
+          #
+          # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo#type
+          module Type
+            extend ContextDev::Internal::Type::Enum
+
+            ICON = :icon
+            LOGO = :logo
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/brand_screenshot_params.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#screenshot
+    class BrandScreenshotParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
+      #   domain will be automatically normalized and validated.
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute full_screenshot
+      #   Optional parameter to determine screenshot type. If 'true', takes a full page
+      #   screenshot capturing all content. If 'false' or not provided, takes a viewport
+      #   screenshot (standard browser view).
+      #
+      #   @return [Symbol, ContextDev::Models::BrandScreenshotParams::FullScreenshot, nil]
+      optional :full_screenshot, enum: -> { ContextDev::BrandScreenshotParams::FullScreenshot }
+
+      # @!attribute page
+      #   Optional parameter to specify which page type to screenshot. If provided, the
+      #   system will scrape the domain's links and use heuristics to find the most
+      #   appropriate URL for the specified page type (30 supported languages). If not
+      #   provided, screenshots the main domain landing page.
+      #
+      #   @return [Symbol, ContextDev::Models::BrandScreenshotParams::Page, nil]
+      optional :page, enum: -> { ContextDev::BrandScreenshotParams::Page }
+
+      # @!attribute prioritize
+      #   Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
+      #   faster capture with basic quality. If 'quality', optimizes for higher quality
+      #   with longer wait times. Defaults to 'quality' if not provided.
+      #
+      #   @return [Symbol, ContextDev::Models::BrandScreenshotParams::Prioritize, nil]
+      optional :prioritize, enum: -> { ContextDev::BrandScreenshotParams::Prioritize }
+
+      # @!method initialize(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BrandScreenshotParams} for more details.
+      #
+      #   @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai
+      #
+      #   @param full_screenshot [Symbol, ContextDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc
+      #
+      #   @param page [Symbol, ContextDev::Models::BrandScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy
+      #
+      #   @param prioritize [Symbol, ContextDev::Models::BrandScreenshotParams::Prioritize] Optional parameter to prioritize screenshot capture. If 'speed', optimizes for f
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Optional parameter to determine screenshot type. If 'true', takes a full page
+      # screenshot capturing all content. If 'false' or not provided, takes a viewport
+      # screenshot (standard browser view).
+      module FullScreenshot
+        extend ContextDev::Internal::Type::Enum
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Optional parameter to specify which page type to screenshot. If provided, the
+      # system will scrape the domain's links and use heuristics to find the most
+      # appropriate URL for the specified page type (30 supported languages). If not
+      # provided, screenshots the main domain landing page.
+      module Page
+        extend ContextDev::Internal::Type::Enum
+
+        LOGIN = :login
+        SIGNUP = :signup
+        BLOG = :blog
+        CAREERS = :careers
+        PRICING = :pricing
+        TERMS = :terms
+        PRIVACY = :privacy
+        CONTACT = :contact
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for
+      # faster capture with basic quality. If 'quality', optimizes for higher quality
+      # with longer wait times. Defaults to 'quality' if not provided.
+      module Prioritize
+        extend ContextDev::Internal::Type::Enum
+
+        SPEED = :speed
+        QUALITY = :quality
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/context_dev/models/brand_screenshot_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#screenshot
+    class BrandScreenshotResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute code
+      #   HTTP status code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute domain
+      #   The normalized domain that was processed
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute screenshot
+      #   Public URL of the uploaded screenshot image
+      #
+      #   @return [String, nil]
+      optional :screenshot, String
+
+      # @!attribute screenshot_type
+      #   Type of screenshot that was captured
+      #
+      #   @return [Symbol, ContextDev::Models::BrandScreenshotResponse::ScreenshotType, nil]
+      optional :screenshot_type,
+               enum: -> { ContextDev::Models::BrandScreenshotResponse::ScreenshotType },
+               api_name: :screenshotType
+
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(code: nil, domain: nil, screenshot: nil, screenshot_type: nil, status: nil)
+      #   @param code [Integer] HTTP status code
+      #
+      #   @param domain [String] The normalized domain that was processed
+      #
+      #   @param screenshot [String] Public URL of the uploaded screenshot image
+      #
+      #   @param screenshot_type [Symbol, ContextDev::Models::BrandScreenshotResponse::ScreenshotType] Type of screenshot that was captured
+      #
+      #   @param status [String] Status of the response, e.g., 'ok'
+
+      # Type of screenshot that was captured
+      #
+      # @see ContextDev::Models::BrandScreenshotResponse#screenshot_type
+      module ScreenshotType
+        extend ContextDev::Internal::Type::Enum
+
+        VIEWPORT = :viewport
+        FULL_PAGE = :fullPage
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/context_dev/models/brand_styleguide_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Brand#styleguide
+    class BrandStyleguideParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute direct_url
+      #   A specific URL to fetch the styleguide from directly, bypassing domain
+      #   resolution (e.g., 'https://example.com/design-system').
+      #
+      #   @return [String, nil]
+      optional :direct_url, String
+
+      # @!attribute domain
+      #   Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+      #   domain will be automatically normalized and validated.
+      #
+      #   @return [String, nil]
+      optional :domain, String
+
+      # @!attribute prioritize
+      #   Optional parameter to prioritize screenshot capture for styleguide extraction.
+      #   If 'speed', optimizes for faster capture with basic quality. If 'quality',
+      #   optimizes for higher quality with longer wait times. Defaults to 'quality' if
+      #   not provided.
+      #
+      #   @return [Symbol, ContextDev::Models::BrandStyleguideParams::Prioritize, nil]
+      optional :prioritize, enum: -> { ContextDev::BrandStyleguideParams::Prioritize }
+
+      # @!attribute timeout_ms
+      #   Optional timeout in milliseconds for the request. If the request takes longer
+      #   than this value, it will be aborted with a 408 status code. Maximum allowed
+      #   value is 300000ms (5 minutes).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer
+
+      # @!method initialize(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BrandStyleguideParams} for more details.
+      #
+      #   @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
+      #
+      #   @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+      #
+      #   @param prioritize [Symbol, ContextDev::Models::BrandStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Optional parameter to prioritize screenshot capture for styleguide extraction.
+      # If 'speed', optimizes for faster capture with basic quality. If 'quality',
+      # optimizes for higher quality with longer wait times. Defaults to 'quality' if
+      # not provided.
+      module Prioritize
+        extend ContextDev::Internal::Type::Enum
+
+        SPEED = :speed
+        QUALITY = :quality
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end