brand.dev 0.1.0.pre.alpha.7 → 0.1.0.pre.alpha.9

data/lib/brand_dev/models/brand_retrieve_simplified_response.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#retrieve_simplified
+    class BrandRetrieveSimplifiedResponse < BrandDev::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Simplified brand information
+      #
+      #   @return [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand, nil]
+      optional :brand, -> { BrandDev::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 [BrandDev::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 BrandDev::Models::BrandRetrieveSimplifiedResponse#brand
+      class Brand < BrandDev::Internal::Type::BaseModel
+        # @!attribute backdrops
+        #   An array of backdrop images for the brand
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop>, nil]
+        optional :backdrops,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop] }
+
+        # @!attribute colors
+        #   An array of brand colors
+        #
+        #   @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color>, nil]
+        optional :colors,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::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<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo>, nil]
+        optional :logos,
+                 -> { BrandDev::Internal::Type::ArrayOf[BrandDev::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<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop>] An array of backdrop images for the brand
+        #
+        #   @param colors [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color>] An array of brand colors
+        #
+        #   @param domain [String] The domain name of the brand
+        #
+        #   @param logos [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo>] An array of logos associated with the brand
+        #
+        #   @param title [String] The title or name of the brand
+
+        class Backdrop < BrandDev::Internal::Type::BaseModel
+          # @!attribute colors
+          #   Array of colors in the backdrop image
+          #
+          #   @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color>, nil]
+          optional :colors,
+                   -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color] }
+
+          # @!attribute resolution
+          #   Resolution of the backdrop image
+          #
+          #   @return [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution, nil]
+          optional :resolution,
+                   -> { BrandDev::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<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color>] Array of colors in the backdrop image
+          #
+          #   @param resolution [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution] Resolution of the backdrop image
+          #
+          #   @param url [String] URL of the backdrop image
+
+          class Color < BrandDev::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 BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop#resolution
+          class Resolution < BrandDev::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 < BrandDev::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 < BrandDev::Internal::Type::BaseModel
+          # @!attribute colors
+          #   Array of colors in the logo
+          #
+          #   @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color>, nil]
+          optional :colors,
+                   -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color] }
+
+          # @!attribute group
+          #   Group identifier for logos
+          #
+          #   @return [Integer, nil]
+          optional :group, Integer
+
+          # @!attribute mode
+          #   Mode of the logo, e.g., 'dark', 'light'
+          #
+          #   @return [String, nil]
+          optional :mode, String
+
+          # @!attribute resolution
+          #   Resolution of the logo image
+          #
+          #   @return [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution, nil]
+          optional :resolution, -> { BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution }
+
+          # @!attribute type
+          #   Type of the logo based on resolution (e.g., 'icon', 'logo', 'banner')
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!attribute url
+          #   URL of the logo image
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(colors: nil, group: nil, mode: nil, resolution: nil, type: nil, url: nil)
+          #   @param colors [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color>] Array of colors in the logo
+          #
+          #   @param group [Integer] Group identifier for logos
+          #
+          #   @param mode [String] Mode of the logo, e.g., 'dark', 'light'
+          #
+          #   @param resolution [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution] Resolution of the logo image
+          #
+          #   @param type [String] Type of the logo based on resolution (e.g., 'icon', 'logo', 'banner')
+          #
+          #   @param url [String] URL of the logo image
+
+          class Color < BrandDev::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 BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo#resolution
+          class Resolution < BrandDev::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
+        end
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_screenshot_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#screenshot
+    class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::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, BrandDev::Models::BrandScreenshotParams::FullScreenshot, nil]
+      optional :full_screenshot, enum: -> { BrandDev::BrandScreenshotParams::FullScreenshot }
+
+      # @!method initialize(domain:, full_screenshot: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {BrandDev::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, BrandDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc
+      #
+      #   @param request_options [BrandDev::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 BrandDev::Internal::Type::Enum
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_screenshot_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#screenshot
+    class BrandScreenshotResponse < BrandDev::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, BrandDev::Models::BrandScreenshotResponse::ScreenshotType, nil]
+      optional :screenshot_type,
+               enum: -> { BrandDev::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, BrandDev::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 BrandDev::Models::BrandScreenshotResponse#screenshot_type
+      module ScreenshotType
+        extend BrandDev::Internal::Type::Enum
+
+        VIEWPORT = :viewport
+        FULL_PAGE = :fullPage
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/brand_dev/models/brand_styleguide_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module BrandDev
+  module Models
+    # @see BrandDev::Resources::Brand#styleguide
+    class BrandStyleguideParams < BrandDev::Internal::Type::BaseModel
+      extend BrandDev::Internal::Type::RequestParameters::Converter
+      include BrandDev::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #   Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+      #   domain will be automatically normalized and validated.
+      #
+      #   @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
+      #   {BrandDev::Models::BrandStyleguideParams} for more details.
+      #
+      #   @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
+      #
+      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end