context.dev 2.18.0 → 2.19.0

data/lib/context_dev/models/brand_retrieve_simplified_response.rb

@@ -1,441 +0,0 @@
-# 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]
-      required :brand, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand }
-
-      # @!attribute cache_metadata
-      #   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.
-      #
-      #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata]
-      required :cache_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata }
-
-      # @!attribute code
-      #   HTTP status code of the response
-      #
-      #   @return [Integer]
-      required :code, Integer
-
-      # @!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 status
-      #   Status of the response, e.g., 'ok'
-      #
-      #   @return [String]
-      required :status, String
-
-      # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
-      #
-      #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, nil]
-      optional :key_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata }
-
-      # @!attribute partial
-      #   True when the timeout ended processing and only completed brand data is
-      #   returned.
-      #
-      #   @return [Boolean, nil]
-      optional :partial, ContextDev::Internal::Type::Boolean
-
-      # @!method initialize(brand:, cache_metadata:, code:, request_id:, status:, key_metadata: nil, partial: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details.
-      #
-      #   @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
-      #
-      #   @param cache_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
-      #
-      #   @param code [Integer] HTTP status code of the response
-      #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #
-      #   @param status [String] Status of the response, e.g., 'ok'
-      #
-      #   @param key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
-      #
-      #   @param partial [Boolean] True when the timeout ended processing and only completed brand data is returned
-
-      # @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
-
-          # @!attribute source
-          #   Where the color was observed: 'site' colors come from the website's own theme
-          #   signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
-          #   logo image pixels.
-          #
-          #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source, nil]
-          optional :source, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source }
-
-          # @!method initialize(hex: nil, name: nil, source: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color} for more
-          #   details.
-          #
-          #   @param hex [String] Color in hexadecimal format
-          #
-          #   @param name [String] Name of the color
-          #
-          #   @param source [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source] Where the color was observed: 'site' colors come from the website's own theme si
-
-          # Where the color was observed: 'site' colors come from the website's own theme
-          # signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
-          # logo image pixels.
-          #
-          # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color#source
-          module Source
-            extend ContextDev::Internal::Type::Enum
-
-            SITE = :site
-            LOGO = :logo
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        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
-
-      # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#cache_metadata
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute age_ms
-        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @return [Integer]
-        required :age_ms, Integer
-
-        # @!attribute status
-        #   Whether the response was served from cache, required fresh work, or honored
-        #   zero-data-retention cache bypass.
-        #
-        #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status]
-        required :status, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status }
-
-        # @!method initialize(age_ms:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata} for more
-        #   details.
-        #
-        #   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.
-        #
-        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @param status [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        #
-        # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata#status
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT = :hit
-          MISS = :miss
-          ZDR = :zdr
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#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/models/web_extract_fonts_params.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::Web#extract_fonts
-    class WebExtractFontsParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      # @!attribute direct_url
-      #   A specific URL to fetch fonts from directly, bypassing domain resolution (e.g.,
-      #   'https://example.com/design-system'). When provided, fonts are extracted from
-      #   this exact URL. You must provide either 'domain' or 'directUrl', but not both.
-      #
-      #   @return [String, nil]
-      optional :direct_url, String
-
-      # @!attribute domain
-      #   Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The
-      #   domain will be automatically normalized and validated. You must provide either
-      #   'domain' or 'directUrl', but not both.
-      #
-      #   @return [String, nil]
-      optional :domain, String
-
-      # @!attribute max_age_ms
-      #   Maximum age in milliseconds for cached brand data before the API performs a hard
-      #   refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
-      #   refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
-      #   are clamped to 1 year.
-      #
-      #   @return [Integer, nil]
-      optional :max_age_ms, Integer, nil?: true
-
-      # @!attribute tags
-      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-      #   characters.
-      #
-      #   @return [Array<String>, nil]
-      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
-
-      # @!attribute timeout_opts
-      #   Optional request deadline and behavior on timeout. For GET requests, use
-      #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      #   timeoutOpts object.
-      #
-      #   @return [ContextDev::Models::WebExtractFontsParams::TimeoutOpts, nil]
-      optional :timeout_opts, -> { ContextDev::WebExtractFontsParams::TimeoutOpts }
-
-      # @!method initialize(direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::WebExtractFontsParams} for more details.
-      #
-      #   @param direct_url [String] A specific URL to fetch fonts from directly, bypassing domain resolution (e.g.,
-      #
-      #   @param domain [String] Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domai
-      #
-      #   @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
-      #
-      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
-      #
-      #   @param timeout_opts [ContextDev::Models::WebExtractFontsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
-      #
-      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
-
-      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
-        # @!attribute milliseconds
-        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-        #
-        #   @return [Integer]
-        required :milliseconds, Integer
-
-        # @!attribute behavior
-        #   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. "return-partial" requires milliseconds of at
-        #   least 5000.
-        #
-        #   @return [Symbol, ContextDev::Models::WebExtractFontsParams::TimeoutOpts::Behavior, nil]
-        optional :behavior, enum: -> { ContextDev::WebExtractFontsParams::TimeoutOpts::Behavior }
-
-        # @!method initialize(milliseconds:, behavior: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::WebExtractFontsParams::TimeoutOpts} for more details.
-        #
-        #   Optional request deadline and behavior on timeout. For GET requests, use
-        #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        #   timeoutOpts object.
-        #
-        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-        #
-        #   @param behavior [Symbol, ContextDev::Models::WebExtractFontsParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-
-        # 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. "return-partial" requires milliseconds of at
-        # least 5000.
-        #
-        # @see ContextDev::Models::WebExtractFontsParams::TimeoutOpts#behavior
-        module Behavior
-          extend ContextDev::Internal::Type::Enum
-
-          FAIL = :fail
-          RETURN_PARTIAL = :"return-partial"
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end