imagekitio 3.1.0 → 4.0.0

data/lib/imagekitio/models/overlay_timing.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class OverlayTiming < Imagekitio::Internal::Type::BaseModel
+      # @!attribute duration
+      #   Specifies the duration (in seconds) during which the overlay should appear on
+      #   the base video. Accepts a positive number up to two decimal places (e.g., `20`
+      #   or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`.
+      #   Applies only if the base asset is a video. Maps to `ldu` in the URL.
+      #
+      #   @return [Float, String, nil]
+      optional :duration, union: -> { Imagekitio::OverlayTiming::Duration }
+
+      # @!attribute end_
+      #   Specifies the end time (in seconds) for when the overlay should disappear from
+      #   the base video. If both end and duration are provided, duration is ignored.
+      #   Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and
+      #   arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if
+      #   the base asset is a video. Maps to `leo` in the URL.
+      #
+      #   @return [Float, String, nil]
+      optional :end_, union: -> { Imagekitio::OverlayTiming::End }, api_name: :end
+
+      # @!attribute start
+      #   Specifies the start time (in seconds) for when the overlay should appear on the
+      #   base video. Accepts a positive number up to two decimal places (e.g., `20` or
+      #   `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`.
+      #   Applies only if the base asset is a video. Maps to `lso` in the URL.
+      #
+      #   @return [Float, String, nil]
+      optional :start, union: -> { Imagekitio::OverlayTiming::Start }
+
+      # @!method initialize(duration: nil, end_: nil, start: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::OverlayTiming} for more details.
+      #
+      #   @param duration [Float, String] Specifies the duration (in seconds) during which the overlay should appear on th
+      #
+      #   @param end_ [Float, String] Specifies the end time (in seconds) for when the overlay should disappear from t
+      #
+      #   @param start [Float, String] Specifies the start time (in seconds) for when the overlay should appear on the
+
+      # Specifies the duration (in seconds) during which the overlay should appear on
+      # the base video. Accepts a positive number up to two decimal places (e.g., `20`
+      # or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`.
+      # Applies only if the base asset is a video. Maps to `ldu` in the URL.
+      #
+      # @see Imagekitio::Models::OverlayTiming#duration
+      module Duration
+        extend Imagekitio::Internal::Type::Union
+
+        variant Float
+
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Float, String)]
+      end
+
+      # Specifies the end time (in seconds) for when the overlay should disappear from
+      # the base video. If both end and duration are provided, duration is ignored.
+      # Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and
+      # arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if
+      # the base asset is a video. Maps to `leo` in the URL.
+      #
+      # @see Imagekitio::Models::OverlayTiming#end_
+      module End
+        extend Imagekitio::Internal::Type::Union
+
+        variant Float
+
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Float, String)]
+      end
+
+      # Specifies the start time (in seconds) for when the overlay should appear on the
+      # base video. Accepts a positive number up to two decimal places (e.g., `20` or
+      # `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`.
+      # Applies only if the base asset is a video. Maps to `lso` in the URL.
+      #
+      # @see Imagekitio::Models::OverlayTiming#start
+      module Start
+        extend Imagekitio::Internal::Type::Union
+
+        variant Float
+
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Float, String)]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/responsive_image_attributes.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class ResponsiveImageAttributes < Imagekitio::Internal::Type::BaseModel
+      # @!attribute src
+      #   URL for the _largest_ candidate (assigned to plain `src`).
+      #
+      #   @return [String]
+      required :src, String
+
+      # @!attribute sizes
+      #   `sizes` returned (or synthesised as `100vw`). The value for the HTML `sizes`
+      #   attribute.
+      #
+      #   @return [String, nil]
+      optional :sizes, String
+
+      # @!attribute src_set
+      #   Candidate set with `w` or `x` descriptors. Multiple image URLs separated by
+      #   commas, each with a descriptor.
+      #
+      #   @return [String, nil]
+      optional :src_set, String, api_name: :srcSet
+
+      # @!attribute width
+      #   Width as a number (if `width` was provided in the input options).
+      #
+      #   @return [Float, nil]
+      optional :width, Float
+
+      # @!method initialize(src:, sizes: nil, src_set: nil, width: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::ResponsiveImageAttributes} for more details.
+      #
+      #   Resulting set of attributes suitable for an HTML `<img>` element. Useful for
+      #   enabling responsive image loading with `srcSet` and `sizes`.
+      #
+      #   @param src [String] URL for the _largest_ candidate (assigned to plain `src`).
+      #
+      #   @param sizes [String] `sizes` returned (or synthesised as `100vw`).
+      #
+      #   @param src_set [String] Candidate set with `w` or `x` descriptors.
+      #
+      #   @param width [Float] Width as a number (if `width` was provided in the input options).
+    end
+  end
+end

data/lib/imagekitio/models/solid_color_overlay.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class SolidColorOverlay < Imagekitio::Models::BaseOverlay
+      # @!attribute color
+      #   Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA
+      #   code (e.g., `FFAABB50`), or a color name (e.g., `red`). If an 8-character value
+      #   is provided, the last two characters represent the opacity level (from `00` for
+      #   0.00 to `99` for 0.99).
+      #
+      #   @return [String]
+      required :color, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :solidColor]
+      required :type, const: :solidColor
+
+      # @!attribute transformation
+      #   Control width and height of the solid color overlay. Supported transformations
+      #   depend on the base/parent asset. See overlays on
+      #   [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay)
+      #   and
+      #   [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay).
+      #
+      #   @return [Array<Imagekitio::Models::SolidColorOverlayTransformation>, nil]
+      optional :transformation,
+               -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::SolidColorOverlayTransformation] }
+
+      # @!method initialize(color:, transformation: nil, type: :solidColor)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::SolidColorOverlay} for more details.
+      #
+      #   @param color [String] Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA
+      #
+      #   @param transformation [Array<Imagekitio::Models::SolidColorOverlayTransformation>] Control width and height of the solid color overlay. Supported transformations d
+      #
+      #   @param type [Symbol, :solidColor]
+    end
+  end
+end

data/lib/imagekitio/models/solid_color_overlay_transformation.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class SolidColorOverlayTransformation < Imagekitio::Internal::Type::BaseModel
+      # @!attribute alpha
+      #   Specifies the transparency level of the solid color overlay. Accepts integers
+      #   from `1` to `9`.
+      #
+      #   @return [Float, nil]
+      optional :alpha, Float
+
+      # @!attribute background
+      #   Specifies the background color of the solid color overlay. Accepts an RGB hex
+      #   code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
+      #
+      #   @return [String, nil]
+      optional :background, String
+
+      # @!attribute gradient
+      #   Creates a linear gradient with two colors. Pass `true` for a default gradient,
+      #   or provide a string for a custom gradient. Only works if the base asset is an
+      #   image. See
+      #   [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
+      #
+      #   @return [Boolean, true, String, nil]
+      optional :gradient, union: -> { Imagekitio::SolidColorOverlayTransformation::Gradient }
+
+      # @!attribute height
+      #   Controls the height of the solid color overlay. Accepts a numeric value or an
+      #   arithmetic expression. Learn about
+      #   [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
+      #
+      #   @return [Float, String, nil]
+      optional :height, union: -> { Imagekitio::SolidColorOverlayTransformation::Height }
+
+      # @!attribute radius
+      #   Specifies the corner radius of the solid color overlay. Set to `max` for
+      #   circular or oval shape. See
+      #   [radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
+      #
+      #   @return [Float, Symbol, :max, nil]
+      optional :radius, union: -> { Imagekitio::SolidColorOverlayTransformation::Radius }
+
+      # @!attribute width
+      #   Controls the width of the solid color overlay. Accepts a numeric value or an
+      #   arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about
+      #   [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
+      #
+      #   @return [Float, String, nil]
+      optional :width, union: -> { Imagekitio::SolidColorOverlayTransformation::Width }
+
+      # @!method initialize(alpha: nil, background: nil, gradient: nil, height: nil, radius: nil, width: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::SolidColorOverlayTransformation} for more details.
+      #
+      #   @param alpha [Float] Specifies the transparency level of the solid color overlay. Accepts integers fr
+      #
+      #   @param background [String] Specifies the background color of the solid color overlay. Accepts an RGB hex co
+      #
+      #   @param gradient [Boolean, true, String] Creates a linear gradient with two colors. Pass `true` for a default gradient, o
+      #
+      #   @param height [Float, String] Controls the height of the solid color overlay. Accepts a numeric value or an ar
+      #
+      #   @param radius [Float, Symbol, :max] Specifies the corner radius of the solid color overlay. Set to `max` for circula
+      #
+      #   @param width [Float, String] Controls the width of the solid color overlay. Accepts a numeric value or an ari
+
+      # Creates a linear gradient with two colors. Pass `true` for a default gradient,
+      # or provide a string for a custom gradient. Only works if the base asset is an
+      # image. See
+      # [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
+      #
+      # @see Imagekitio::Models::SolidColorOverlayTransformation#gradient
+      module Gradient
+        extend Imagekitio::Internal::Type::Union
+
+        variant const: true
+
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Boolean, true, String)]
+      end
+
+      # Controls the height of the solid color overlay. Accepts a numeric value or an
+      # arithmetic expression. Learn about
+      # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
+      #
+      # @see Imagekitio::Models::SolidColorOverlayTransformation#height
+      module Height
+        extend Imagekitio::Internal::Type::Union
+
+        variant Float
+
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Float, String)]
+      end
+
+      # Specifies the corner radius of the solid color overlay. Set to `max` for
+      # circular or oval shape. See
+      # [radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
+      #
+      # @see Imagekitio::Models::SolidColorOverlayTransformation#radius
+      module Radius
+        extend Imagekitio::Internal::Type::Union
+
+        variant Float
+
+        variant const: :max
+
+        # @!method self.variants
+        #   @return [Array(Float, Symbol, :max)]
+      end
+
+      # Controls the width of the solid color overlay. Accepts a numeric value or an
+      # arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about
+      # [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
+      #
+      # @see Imagekitio::Models::SolidColorOverlayTransformation#width
+      module Width
+        extend Imagekitio::Internal::Type::Union
+
+        variant Float
+
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Float, String)]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/src_options.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class SrcOptions < Imagekitio::Internal::Type::BaseModel
+      # @!attribute src
+      #   Accepts a relative or absolute path of the resource. If a relative path is
+      #   provided, it is appended to the `urlEndpoint`. If an absolute path is provided,
+      #   `urlEndpoint` is ignored.
+      #
+      #   @return [String]
+      required :src, String
+
+      # @!attribute url_endpoint
+      #   Get your urlEndpoint from the
+      #   [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints).
+      #
+      #   @return [String]
+      required :url_endpoint, String, api_name: :urlEndpoint
+
+      # @!attribute expires_in
+      #   When you want the signed URL to expire, specified in seconds. If `expiresIn` is
+      #   anything above 0, the URL will always be signed even if `signed` is set to
+      #   false. If not specified and `signed` is `true`, the signed URL will not expire
+      #   (valid indefinitely).
+      #
+      #   Example: Setting `expiresIn: 3600` will make the URL expire 1 hour from
+      #   generation time. After the expiry time, the signed URL will no longer be valid
+      #   and ImageKit will return a 401 Unauthorized status code.
+      #
+      #   [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls).
+      #
+      #   @return [Float, nil]
+      optional :expires_in, Float, api_name: :expiresIn
+
+      # @!attribute query_parameters
+      #   These are additional query parameters that you want to add to the final URL.
+      #   They can be any query parameters and not necessarily related to ImageKit. This
+      #   is especially useful if you want to add a versioning parameter to your URLs.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :query_parameters, Imagekitio::Internal::Type::HashOf[String], api_name: :queryParameters
+
+      # @!attribute signed
+      #   Whether to sign the URL or not. Set this to `true` if you want to generate a
+      #   signed URL. If `signed` is `true` and `expiresIn` is not specified, the signed
+      #   URL will not expire (valid indefinitely). Note: If `expiresIn` is set to any
+      #   value above 0, the URL will always be signed regardless of this setting.
+      #   [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls).
+      #
+      #   @return [Boolean, nil]
+      optional :signed, Imagekitio::Internal::Type::Boolean
+
+      # @!attribute transformation
+      #   An array of objects specifying the transformations to be applied in the URL. If
+      #   more than one transformation is specified, they are applied in the order they
+      #   are specified as chained transformations. See
+      #   [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations).
+      #
+      #   @return [Array<Imagekitio::Models::Transformation>, nil]
+      optional :transformation, -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Transformation] }
+
+      # @!attribute transformation_position
+      #   By default, the transformation string is added as a query parameter in the URL,
+      #   e.g., `?tr=w-100,h-100`. If you want to add the transformation string in the
+      #   path of the URL, set this to `path`. Learn more in the
+      #   [Transformations guide](https://imagekit.io/docs/transformations).
+      #
+      #   @return [Symbol, Imagekitio::Models::TransformationPosition, nil]
+      optional :transformation_position,
+               enum: -> { Imagekitio::TransformationPosition },
+               api_name: :transformationPosition
+
+      # @!method initialize(src:, url_endpoint:, expires_in: nil, query_parameters: nil, signed: nil, transformation: nil, transformation_position: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::SrcOptions} for more details.
+      #
+      #   Options for generating ImageKit URLs with transformations. See the
+      #   [Transformations guide](https://imagekit.io/docs/transformations).
+      #
+      #   @param src [String] Accepts a relative or absolute path of the resource. If a relative path is provi
+      #
+      #   @param url_endpoint [String] Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard
+      #
+      #   @param expires_in [Float] When you want the signed URL to expire, specified in seconds. If `expiresIn` is
+      #
+      #   @param query_parameters [Hash{Symbol=>String}] These are additional query parameters that you want to add to the final URL.
+      #
+      #   @param signed [Boolean] Whether to sign the URL or not. Set this to `true` if you want to generate a sig
+      #
+      #   @param transformation [Array<Imagekitio::Models::Transformation>] An array of objects specifying the transformations to be applied in the URL. If
+      #
+      #   @param transformation_position [Symbol, Imagekitio::Models::TransformationPosition] By default, the transformation string is added as a query parameter in the URL,
+    end
+  end
+end

data/lib/imagekitio/models/streaming_resolution.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # Available streaming resolutions for
+    # [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming)
+    module StreamingResolution
+      extend Imagekitio::Internal::Type::Enum
+
+      STREAMING_RESOLUTION_240 = :"240"
+      STREAMING_RESOLUTION_360 = :"360"
+      STREAMING_RESOLUTION_480 = :"480"
+      STREAMING_RESOLUTION_720 = :"720"
+      STREAMING_RESOLUTION_1080 = :"1080"
+      STREAMING_RESOLUTION_1440 = :"1440"
+      STREAMING_RESOLUTION_2160 = :"2160"
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/imagekitio/models/subtitle_overlay.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class SubtitleOverlay < Imagekitio::Models::BaseOverlay
+      # @!attribute input
+      #   Specifies the relative path to the subtitle file used as an overlay.
+      #
+      #   @return [String]
+      required :input, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :subtitle]
+      required :type, const: :subtitle
+
+      # @!attribute encoding
+      #   The input path can be included in the layer as either `i-{input}` or
+      #   `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate
+      #   format automatically. To always use base64 encoding (`ie-{base64}`), set this
+      #   parameter to `base64`. To always use plain text (`i-{input}`), set it to
+      #   `plain`.
+      #
+      #   @return [Symbol, Imagekitio::Models::SubtitleOverlay::Encoding, nil]
+      optional :encoding, enum: -> { Imagekitio::SubtitleOverlay::Encoding }
+
+      # @!attribute transformation
+      #   Control styling of the subtitle. See
+      #   [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer).
+      #
+      #   @return [Array<Imagekitio::Models::SubtitleOverlayTransformation>, nil]
+      optional :transformation,
+               -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::SubtitleOverlayTransformation] }
+
+      # @!method initialize(input:, encoding: nil, transformation: nil, type: :subtitle)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::SubtitleOverlay} for more details.
+      #
+      #   @param input [String] Specifies the relative path to the subtitle file used as an overlay.
+      #
+      #   @param encoding [Symbol, Imagekitio::Models::SubtitleOverlay::Encoding] The input path can be included in the layer as either `i-{input}` or `ie-{base64
+      #
+      #   @param transformation [Array<Imagekitio::Models::SubtitleOverlayTransformation>] Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/doc
+      #
+      #   @param type [Symbol, :subtitle]
+
+      # The input path can be included in the layer as either `i-{input}` or
+      # `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate
+      # format automatically. To always use base64 encoding (`ie-{base64}`), set this
+      # parameter to `base64`. To always use plain text (`i-{input}`), set it to
+      # `plain`.
+      module Encoding
+        extend Imagekitio::Internal::Type::Enum
+
+        AUTO = :auto
+        PLAIN = :plain
+        BASE64 = :base64
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/imagekitio/models/subtitle_overlay_transformation.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class SubtitleOverlayTransformation < Imagekitio::Internal::Type::BaseModel
+      # @!attribute background
+      #   Specifies the subtitle background color using a standard color name, an RGB
+      #   color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50).
+      #
+      #   [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
+      #
+      #   @return [String, nil]
+      optional :background, String
+
+      # @!attribute color
+      #   Sets the font color of the subtitle text using a standard color name, an RGB
+      #   color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50).
+      #
+      #   [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
+      #
+      #   @return [String, nil]
+      optional :color, String
+
+      # @!attribute font_family
+      #   Font family for subtitles. Refer to the
+      #   [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list).
+      #
+      #   @return [String, nil]
+      optional :font_family, String, api_name: :fontFamily
+
+      # @!attribute font_outline
+      #   Sets the font outline of the subtitle text. Requires the outline width (an
+      #   integer) and the outline color (as an RGB color code, RGBA color code, or
+      #   standard web color name) separated by an underscore. Example: `fol-2_blue`
+      #   (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of
+      #   2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and
+      #   outline color `#A1CCDD` at 50% opacity).
+      #
+      #   [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
+      #
+      #   @return [String, nil]
+      optional :font_outline, String, api_name: :fontOutline
+
+      # @!attribute font_shadow
+      #   Sets the font shadow for the subtitle text. Requires the shadow color (as an RGB
+      #   color code, RGBA color code, or standard web color name) and shadow indent (an
+      #   integer) separated by an underscore. Example: `fsh-blue_2` (shadow color blue,
+      #   indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px),
+      #   `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px).
+      #
+      #   [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
+      #
+      #   @return [String, nil]
+      optional :font_shadow, String, api_name: :fontShadow
+
+      # @!attribute font_size
+      #   Sets the font size of subtitle text.
+      #
+      #   [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
+      #
+      #   @return [Float, nil]
+      optional :font_size, Float, api_name: :fontSize
+
+      # @!attribute typography
+      #   Sets the typography style of the subtitle text. Supports values are `b` for
+      #   bold, `i` for italics, and `b_i` for bold with italics.
+      #
+      #   [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
+      #
+      #   @return [Symbol, Imagekitio::Models::SubtitleOverlayTransformation::Typography, nil]
+      optional :typography, enum: -> { Imagekitio::SubtitleOverlayTransformation::Typography }
+
+      # @!method initialize(background: nil, color: nil, font_family: nil, font_outline: nil, font_shadow: nil, font_size: nil, typography: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::SubtitleOverlayTransformation} for more details.
+      #
+      #   Subtitle styling options.
+      #   [Learn more](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
+      #   from the docs.
+      #
+      #   @param background [String] Specifies the subtitle background color using a standard color name, an RGB colo
+      #
+      #   @param color [String] Sets the font color of the subtitle text using a standard color name, an RGB col
+      #
+      #   @param font_family [String] Font family for subtitles. Refer to the [supported fonts](https://imagekit.io/do
+      #
+      #   @param font_outline [String] Sets the font outline of the subtitle text.
+      #
+      #   @param font_shadow [String] Sets the font shadow for the subtitle text.
+      #
+      #   @param font_size [Float] Sets the font size of subtitle text.
+      #
+      #   @param typography [Symbol, Imagekitio::Models::SubtitleOverlayTransformation::Typography] Sets the typography style of the subtitle text. Supports values are `b` for bold
+
+      # Sets the typography style of the subtitle text. Supports values are `b` for
+      # bold, `i` for italics, and `b_i` for bold with italics.
+      #
+      # [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
+      #
+      # @see Imagekitio::Models::SubtitleOverlayTransformation#typography
+      module Typography
+        extend Imagekitio::Internal::Type::Enum
+
+        B = :b
+        I = :i
+        B_I = :b_i
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end