vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/workflow_caption_background_style.rb

@@ -0,0 +1,133 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Background drawn behind caption text.
+  class WorkflowCaptionBackgroundStyle < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # RECT draws one rectangle behind the whole line; WRAPPED hugs the text;
+    # WORD_BY_WORD draws a box per word.
+    # @return [WorkflowCaptionBackgroundStyleType]
+    attr_accessor :type
+
+    # An RGB color. Each channel is an integer from 0 to 255.
+    # @return [WorkflowRgbColor]
+    attr_accessor :background_color
+
+    # Corner rounding as a proportion of the background height, between 0
+    # (square corners) and 1 (fully rounded).
+    # @return [Float]
+    attr_accessor :border_radius_proportion
+
+    # Background opacity from 0 (transparent) to 1 (opaque).
+    # @return [Float]
+    attr_accessor :opacity_proportion
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['background_color'] = 'backgroundColor'
+      @_hash['border_radius_proportion'] = 'borderRadiusProportion'
+      @_hash['opacity_proportion'] = 'opacityProportion'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        border_radius_proportion
+        opacity_proportion
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, background_color:, border_radius_proportion: SKIP,
+                   opacity_proportion: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @background_color = background_color
+      @border_radius_proportion = border_radius_proportion unless border_radius_proportion == SKIP
+      @opacity_proportion = opacity_proportion unless opacity_proportion == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : nil
+      background_color = WorkflowRgbColor.from_hash(hash['backgroundColor']) if
+        hash['backgroundColor']
+      border_radius_proportion =
+        hash.key?('borderRadiusProportion') ? hash['borderRadiusProportion'] : SKIP
+      opacity_proportion =
+        hash.key?('opacityProportion') ? hash['opacityProportion'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      WorkflowCaptionBackgroundStyle.new(type: type,
+                                         background_color: background_color,
+                                         border_radius_proportion: border_radius_proportion,
+                                         opacity_proportion: opacity_proportion,
+                                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [WorkflowCaptionBackgroundStyle | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.type,
+                                ->(val) { WorkflowCaptionBackgroundStyleType.validate(val) }) and
+            APIHelper.valid_type?(value.background_color,
+                                  ->(val) { WorkflowRgbColor.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { WorkflowCaptionBackgroundStyleType.validate(val) }) and
+          APIHelper.valid_type?(value['backgroundColor'],
+                                ->(val) { WorkflowRgbColor.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, background_color: #{@background_color},"\
+      " border_radius_proportion: #{@border_radius_proportion}, opacity_proportion:"\
+      " #{@opacity_proportion}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, background_color: #{@background_color.inspect},"\
+      " border_radius_proportion: #{@border_radius_proportion.inspect}, opacity_proportion:"\
+      " #{@opacity_proportion.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/workflow_caption_background_style_type.rb

@@ -0,0 +1,41 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # RECT draws one rectangle behind the whole line; WRAPPED hugs the text;
+  # WORD_BY_WORD draws a box per word.
+  class WorkflowCaptionBackgroundStyleType
+    WORKFLOW_CAPTION_BACKGROUND_STYLE_TYPE = [
+      # TODO: Write general description for RECT
+      RECT = 'RECT'.freeze,
+
+      # TODO: Write general description for WRAPPED
+      WRAPPED = 'WRAPPED'.freeze,
+
+      # TODO: Write general description for WORD_BY_WORD
+      WORD_BY_WORD = 'WORD_BY_WORD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WORKFLOW_CAPTION_BACKGROUND_STYLE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = RECT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'rect' then RECT
+      when 'wrapped' then WRAPPED
+      when 'word_by_word' then WORD_BY_WORD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/workflow_caption_style.rb

@@ -0,0 +1,220 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Caption styling. Any omitted field falls back to the VideoGen default
+  # caption style. Provide an empty object (`{}`) to keep the default style but
+  # ensure captions are shown. Pass `null` for the whole `captionStyle` field to
+  # hide captions entirely.
+  class WorkflowCaptionStyle < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Font family name.
+    # @return [String]
+    attr_accessor :font_name
+
+    # Font size in pixels at 1080p. Must be greater than 0.
+    # @return [Float]
+    attr_accessor :font_size
+
+    # Numeric font weight (400 = regular, 700 = bold).
+    # @return [WorkflowCaptionStyleFontWeight]
+    attr_accessor :font_weight
+
+    # An RGB color. Each channel is an integer from 0 to 255.
+    # @return [WorkflowRgbColor]
+    attr_accessor :text_color
+
+    # An RGB color. Each channel is an integer from 0 to 255.
+    # @return [WorkflowCaptionStyleTextJustification]
+    attr_accessor :text_justification
+
+    # Vertical position of the caption block in the frame.
+    # @return [WorkflowCaptionStyleVerticalAlignment]
+    attr_accessor :vertical_alignment
+
+    # Outline color around glyphs, or null for no outline.
+    # @return [WorkflowRgbColor]
+    attr_accessor :stroke_color
+
+    # Outline thickness in pixels. 0 disables the outline.
+    # @return [Float]
+    attr_accessor :stroke_weight
+
+    # Background drawn behind the text, or null for no background.
+    # @return [WorkflowCaptionBackgroundStyle]
+    attr_accessor :background_style
+
+    # Color applied to the currently spoken word for karaoke-style highlighting,
+    # or null to keep the base text color.
+    # @return [WorkflowRgbColor]
+    attr_accessor :spoken_text_color
+
+    # Outline color applied to the currently spoken word, or null.
+    # @return [WorkflowRgbColor]
+    attr_accessor :spoken_text_stroke_color
+
+    # When true, a word keeps the spoken-text color after it has been spoken
+    # instead of reverting.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :persist_spoken_text_color
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['font_name'] = 'fontName'
+      @_hash['font_size'] = 'fontSize'
+      @_hash['font_weight'] = 'fontWeight'
+      @_hash['text_color'] = 'textColor'
+      @_hash['text_justification'] = 'textJustification'
+      @_hash['vertical_alignment'] = 'verticalAlignment'
+      @_hash['stroke_color'] = 'strokeColor'
+      @_hash['stroke_weight'] = 'strokeWeight'
+      @_hash['background_style'] = 'backgroundStyle'
+      @_hash['spoken_text_color'] = 'spokenTextColor'
+      @_hash['spoken_text_stroke_color'] = 'spokenTextStrokeColor'
+      @_hash['persist_spoken_text_color'] = 'persistSpokenTextColor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        font_name
+        font_size
+        font_weight
+        text_color
+        text_justification
+        vertical_alignment
+        stroke_color
+        stroke_weight
+        background_style
+        spoken_text_color
+        spoken_text_stroke_color
+        persist_spoken_text_color
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        stroke_color
+        background_style
+        spoken_text_color
+        spoken_text_stroke_color
+      ]
+    end
+
+    def initialize(font_name: SKIP, font_size: SKIP, font_weight: SKIP,
+                   text_color: SKIP, text_justification: SKIP,
+                   vertical_alignment: SKIP, stroke_color: SKIP,
+                   stroke_weight: SKIP, background_style: SKIP,
+                   spoken_text_color: SKIP, spoken_text_stroke_color: SKIP,
+                   persist_spoken_text_color: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @font_name = font_name unless font_name == SKIP
+      @font_size = font_size unless font_size == SKIP
+      @font_weight = font_weight unless font_weight == SKIP
+      @text_color = text_color unless text_color == SKIP
+      @text_justification = text_justification unless text_justification == SKIP
+      @vertical_alignment = vertical_alignment unless vertical_alignment == SKIP
+      @stroke_color = stroke_color unless stroke_color == SKIP
+      @stroke_weight = stroke_weight unless stroke_weight == SKIP
+      @background_style = background_style unless background_style == SKIP
+      @spoken_text_color = spoken_text_color unless spoken_text_color == SKIP
+      @spoken_text_stroke_color = spoken_text_stroke_color unless spoken_text_stroke_color == SKIP
+      unless persist_spoken_text_color == SKIP
+        @persist_spoken_text_color =
+          persist_spoken_text_color
+      end
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      font_name = hash.key?('fontName') ? hash['fontName'] : SKIP
+      font_size = hash.key?('fontSize') ? hash['fontSize'] : SKIP
+      font_weight = hash.key?('fontWeight') ? hash['fontWeight'] : SKIP
+      text_color = WorkflowRgbColor.from_hash(hash['textColor']) if hash['textColor']
+      text_justification =
+        hash.key?('textJustification') ? hash['textJustification'] : SKIP
+      vertical_alignment =
+        hash.key?('verticalAlignment') ? hash['verticalAlignment'] : SKIP
+      stroke_color = WorkflowRgbColor.from_hash(hash['strokeColor']) if hash['strokeColor']
+      stroke_weight = hash.key?('strokeWeight') ? hash['strokeWeight'] : SKIP
+      background_style = WorkflowCaptionBackgroundStyle.from_hash(hash['backgroundStyle']) if
+        hash['backgroundStyle']
+      spoken_text_color = WorkflowRgbColor.from_hash(hash['spokenTextColor']) if
+        hash['spokenTextColor']
+      spoken_text_stroke_color = WorkflowRgbColor.from_hash(hash['spokenTextStrokeColor']) if
+        hash['spokenTextStrokeColor']
+      persist_spoken_text_color =
+        hash.key?('persistSpokenTextColor') ? hash['persistSpokenTextColor'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      WorkflowCaptionStyle.new(font_name: font_name,
+                               font_size: font_size,
+                               font_weight: font_weight,
+                               text_color: text_color,
+                               text_justification: text_justification,
+                               vertical_alignment: vertical_alignment,
+                               stroke_color: stroke_color,
+                               stroke_weight: stroke_weight,
+                               background_style: background_style,
+                               spoken_text_color: spoken_text_color,
+                               spoken_text_stroke_color: spoken_text_stroke_color,
+                               persist_spoken_text_color: persist_spoken_text_color,
+                               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [WorkflowCaptionStyle | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} font_name: #{@font_name}, font_size: #{@font_size}, font_weight:"\
+      " #{@font_weight}, text_color: #{@text_color}, text_justification: #{@text_justification},"\
+      " vertical_alignment: #{@vertical_alignment}, stroke_color: #{@stroke_color}, stroke_weight:"\
+      " #{@stroke_weight}, background_style: #{@background_style}, spoken_text_color:"\
+      " #{@spoken_text_color}, spoken_text_stroke_color: #{@spoken_text_stroke_color},"\
+      " persist_spoken_text_color: #{@persist_spoken_text_color}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} font_name: #{@font_name.inspect}, font_size: #{@font_size.inspect},"\
+      " font_weight: #{@font_weight.inspect}, text_color: #{@text_color.inspect},"\
+      " text_justification: #{@text_justification.inspect}, vertical_alignment:"\
+      " #{@vertical_alignment.inspect}, stroke_color: #{@stroke_color.inspect}, stroke_weight:"\
+      " #{@stroke_weight.inspect}, background_style: #{@background_style.inspect},"\
+      " spoken_text_color: #{@spoken_text_color.inspect}, spoken_text_stroke_color:"\
+      " #{@spoken_text_stroke_color.inspect}, persist_spoken_text_color:"\
+      " #{@persist_spoken_text_color.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/workflow_caption_style_font_weight.rb

@@ -0,0 +1,64 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Numeric font weight (400 = regular, 700 = bold).
+  class WorkflowCaptionStyleFontWeight
+    WORKFLOW_CAPTION_STYLE_FONT_WEIGHT = [
+      # TODO: Write general description for ENUM_100
+      ENUM_100 = '100'.freeze,
+
+      # TODO: Write general description for ENUM_200
+      ENUM_200 = '200'.freeze,
+
+      # TODO: Write general description for ENUM_300
+      ENUM_300 = '300'.freeze,
+
+      # TODO: Write general description for ENUM_400
+      ENUM_400 = '400'.freeze,
+
+      # TODO: Write general description for ENUM_500
+      ENUM_500 = '500'.freeze,
+
+      # TODO: Write general description for ENUM_600
+      ENUM_600 = '600'.freeze,
+
+      # TODO: Write general description for ENUM_700
+      ENUM_700 = '700'.freeze,
+
+      # TODO: Write general description for ENUM_800
+      ENUM_800 = '800'.freeze,
+
+      # TODO: Write general description for ENUM_900
+      ENUM_900 = '900'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WORKFLOW_CAPTION_STYLE_FONT_WEIGHT.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_100)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_100' then ENUM_100
+      when 'enum_200' then ENUM_200
+      when 'enum_300' then ENUM_300
+      when 'enum_400' then ENUM_400
+      when 'enum_500' then ENUM_500
+      when 'enum_600' then ENUM_600
+      when 'enum_700' then ENUM_700
+      when 'enum_800' then ENUM_800
+      when 'enum_900' then ENUM_900
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/workflow_caption_style_text_justification.rb

@@ -0,0 +1,40 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # WorkflowCaptionStyleTextJustification.
+  class WorkflowCaptionStyleTextJustification
+    WORKFLOW_CAPTION_STYLE_TEXT_JUSTIFICATION = [
+      # TODO: Write general description for LEFT
+      LEFT = 'LEFT'.freeze,
+
+      # TODO: Write general description for CENTER
+      CENTER = 'CENTER'.freeze,
+
+      # TODO: Write general description for RIGHT
+      RIGHT = 'RIGHT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WORKFLOW_CAPTION_STYLE_TEXT_JUSTIFICATION.include?(value)
+    end
+
+    def self.from_value(value, default_value = LEFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'left' then LEFT
+      when 'center' then CENTER
+      when 'right' then RIGHT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/workflow_caption_style_vertical_alignment.rb

@@ -0,0 +1,40 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Vertical position of the caption block in the frame.
+  class WorkflowCaptionStyleVerticalAlignment
+    WORKFLOW_CAPTION_STYLE_VERTICAL_ALIGNMENT = [
+      # TODO: Write general description for TOP
+      TOP = 'TOP'.freeze,
+
+      # TODO: Write general description for MIDDLE
+      MIDDLE = 'MIDDLE'.freeze,
+
+      # TODO: Write general description for BOTTOM
+      BOTTOM = 'BOTTOM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WORKFLOW_CAPTION_STYLE_VERTICAL_ALIGNMENT.include?(value)
+    end
+
+    def self.from_value(value, default_value = TOP)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'top' then TOP
+      when 'middle' then MIDDLE
+      when 'bottom' then BOTTOM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/workflow_rgb_color.rb

@@ -0,0 +1,116 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # An RGB color. Each channel is an integer from 0 to 255.
+  class WorkflowRgbColor < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :red
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :green
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :blue
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['red'] = 'red'
+      @_hash['green'] = 'green'
+      @_hash['blue'] = 'blue'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(red:, green:, blue:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @red = red
+      @green = green
+      @blue = blue
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      red = hash.key?('red') ? hash['red'] : nil
+      green = hash.key?('green') ? hash['green'] : nil
+      blue = hash.key?('blue') ? hash['blue'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      WorkflowRgbColor.new(red: red,
+                           green: green,
+                           blue: blue,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [WorkflowRgbColor | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.red,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.green,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.blue,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['red'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['green'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['blue'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} red: #{@red}, green: #{@green}, blue: #{@blue}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} red: #{@red.inspect}, green: #{@green.inspect}, blue: #{@blue.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end