vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/remix_action3.rb

@@ -0,0 +1,85 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Hide captions on every captionable section.
+  class RemixAction3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: DISABLE_CAPTIONS
+    # @return [String]
+    attr_reader :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'DISABLE_CAPTIONS'
+      @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.
+
+
+      # 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.
+      RemixAction3.new(additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction3 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, 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}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action4.rb

@@ -0,0 +1,120 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Stamp transitions across the project. Not per-boundary: each field you set
+  # is applied uniformly to every boundary in that scope, replacing any
+  # transition already there. Set the transition between sections, between
+  # base-layer assets, or both; omit or pass `null` for a scope to leave its
+  # transitions untouched.
+  class RemixAction4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: ADD_TRANSITIONS
+    # @return [String]
+    attr_reader :type
+
+    # Transition applied at every boundary between sections, replacing any
+    # existing section transitions. Omit or pass `null` to leave section
+    # transitions untouched.
+    # @return [RemixTransitionStyle]
+    attr_accessor :section_transition
+
+    # Transition applied at every boundary between base-layer assets within
+    # sections, replacing any existing asset transitions. Omit or pass `null` to
+    # leave asset transitions untouched.
+    # @return [RemixTransitionStyle]
+    attr_accessor :asset_transition
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['section_transition'] = 'sectionTransition'
+      @_hash['asset_transition'] = 'assetTransition'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        section_transition
+        asset_transition
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        section_transition
+        asset_transition
+      ]
+    end
+
+    def initialize(section_transition: SKIP, asset_transition: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'ADD_TRANSITIONS'
+      @section_transition = section_transition unless section_transition == SKIP
+      @asset_transition = asset_transition unless asset_transition == 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.
+      section_transition =
+        hash.key?('sectionTransition') ? hash['sectionTransition'] : SKIP
+      asset_transition =
+        hash.key?('assetTransition') ? hash['assetTransition'] : 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.
+      RemixAction4.new(section_transition: section_transition,
+                       asset_transition: asset_transition,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction4 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, section_transition: #{@section_transition},"\
+      " asset_transition: #{@asset_transition}, 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}, section_transition: #{@section_transition.inspect},"\
+      " asset_transition: #{@asset_transition.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action5.rb

@@ -0,0 +1,88 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Apply a Ken Burns zoom to every eligible still image in the project,
+  # including uploaded images. Replaces any existing still-image effect on those
+  # assets. If the project has no eligible stills, the action is skipped and
+  # completes successfully without changing anything.
+  class RemixAction5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: ADD_ZOOM
+    # @return [String]
+    attr_reader :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'ADD_ZOOM'
+      @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.
+
+
+      # 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.
+      RemixAction5.new(additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction5 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, 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}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action6.rb

@@ -0,0 +1,106 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Change the project's output aspect ratio (e.g. to a vertical 9:16 social
+  # format). The video is re-flowed to the new ratio.
+  class RemixAction6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: RESIZE_PROJECT
+    # @return [String]
+    attr_reader :type
+
+    # Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel
+    # dimensions.
+    # @return [AspectRatio]
+    attr_accessor :aspect_ratio
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['aspect_ratio'] = 'aspectRatio'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(aspect_ratio:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'RESIZE_PROJECT'
+      @aspect_ratio = aspect_ratio
+      @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.
+      aspect_ratio = AspectRatio.from_hash(hash['aspectRatio']) if hash['aspectRatio']
+
+      # 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.
+      RemixAction6.new(aspect_ratio: aspect_ratio,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction6 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.aspect_ratio,
+                                  ->(val) { AspectRatio.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['aspectRatio'],
+                                ->(val) { AspectRatio.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}, aspect_ratio: #{@aspect_ratio}, 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}, aspect_ratio: #{@aspect_ratio.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action7.rb

@@ -0,0 +1,137 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Tighten every transcript in the project by removing silent pauses and/or
+  # filler words. Useful for polishing narration captured from raw recordings.
+  class RemixAction7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: CLEAN_UP_TRANSCRIPT
+    # @return [String]
+    attr_reader :type
+
+    # Remove filler words ("um", "uh", …). Defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :remove_fillers
+
+    # Remove silent pauses longer than `minPauseSeconds`. Defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :remove_pauses
+
+    # Override the filler-word list to remove. Omit or pass `null` to use the
+    # built-in defaults.
+    # @return [Array[String]]
+    attr_accessor :filler_words
+
+    # Shortest pause (in seconds) to remove; pauses below this stay. Omit or
+    # pass `null` to use the default threshold.
+    # @return [Float]
+    attr_accessor :min_pause_seconds
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['remove_fillers'] = 'removeFillers'
+      @_hash['remove_pauses'] = 'removePauses'
+      @_hash['filler_words'] = 'fillerWords'
+      @_hash['min_pause_seconds'] = 'minPauseSeconds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        remove_fillers
+        remove_pauses
+        filler_words
+        min_pause_seconds
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        remove_fillers
+        remove_pauses
+        filler_words
+        min_pause_seconds
+      ]
+    end
+
+    def initialize(remove_fillers: SKIP, remove_pauses: SKIP,
+                   filler_words: SKIP, min_pause_seconds: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'CLEAN_UP_TRANSCRIPT'
+      @remove_fillers = remove_fillers unless remove_fillers == SKIP
+      @remove_pauses = remove_pauses unless remove_pauses == SKIP
+      @filler_words = filler_words unless filler_words == SKIP
+      @min_pause_seconds = min_pause_seconds unless min_pause_seconds == 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.
+      remove_fillers = hash.key?('removeFillers') ? hash['removeFillers'] : SKIP
+      remove_pauses = hash.key?('removePauses') ? hash['removePauses'] : SKIP
+      filler_words = hash.key?('fillerWords') ? hash['fillerWords'] : SKIP
+      min_pause_seconds =
+        hash.key?('minPauseSeconds') ? hash['minPauseSeconds'] : 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.
+      RemixAction7.new(remove_fillers: remove_fillers,
+                       remove_pauses: remove_pauses,
+                       filler_words: filler_words,
+                       min_pause_seconds: min_pause_seconds,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction7 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, remove_fillers: #{@remove_fillers}, remove_pauses:"\
+      " #{@remove_pauses}, filler_words: #{@filler_words}, min_pause_seconds:"\
+      " #{@min_pause_seconds}, 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}, remove_fillers: #{@remove_fillers.inspect},"\
+      " remove_pauses: #{@remove_pauses.inspect}, filler_words: #{@filler_words.inspect},"\
+      " min_pause_seconds: #{@min_pause_seconds.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action8.rb

@@ -0,0 +1,131 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Animate every eligible still image in the project into a short AI video clip
+  # (image-to-video), replacing each image in place. Eligible images are non-SVG
+  # image assets backed by an uploaded or stock file. Runs asynchronously: one
+  # clip is generated per image. If the project has no eligible images, the
+  # action is skipped and completes successfully without changing anything (for
+  # example, a project whose timeline is already all video clips).
+  class RemixAction8 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: CONVERT_IMAGES_TO_VIDEOS
+    # @return [String]
+    attr_reader :type
+
+    # Describe the motion to apply to every image (e.g. "slow cinematic
+    # push-in"). Omit or pass `null` for automatic motion.
+    # @return [String]
+    attr_accessor :motion_prompt
+
+    # Mute the generated clips and suppress generated background music.
+    # Recommended when the clips sit behind a voiceover. Defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mute_output_videos
+
+    # Video generation quality tier for the image-to-video conversions (`LOW`,
+    # `STANDARD`, `HIGH`, or `MAX`). Optional; when omitted, your account's
+    # Default AI quality for video is used (change it at
+    # https://app.videogen.io/settings/account).
+    # @return [ModelQuality1]
+    attr_accessor :quality
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['motion_prompt'] = 'motionPrompt'
+      @_hash['mute_output_videos'] = 'muteOutputVideos'
+      @_hash['quality'] = 'quality'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        motion_prompt
+        mute_output_videos
+        quality
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        motion_prompt
+        mute_output_videos
+      ]
+    end
+
+    def initialize(motion_prompt: SKIP, mute_output_videos: SKIP, quality: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'CONVERT_IMAGES_TO_VIDEOS'
+      @motion_prompt = motion_prompt unless motion_prompt == SKIP
+      @mute_output_videos = mute_output_videos unless mute_output_videos == SKIP
+      @quality = quality unless quality == 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.
+      motion_prompt = hash.key?('motionPrompt') ? hash['motionPrompt'] : SKIP
+      mute_output_videos =
+        hash.key?('muteOutputVideos') ? hash['muteOutputVideos'] : SKIP
+      quality = hash.key?('quality') ? hash['quality'] : 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.
+      RemixAction8.new(motion_prompt: motion_prompt,
+                       mute_output_videos: mute_output_videos,
+                       quality: quality,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction8 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, motion_prompt: #{@motion_prompt}, mute_output_videos:"\
+      " #{@mute_output_videos}, quality: #{@quality}, 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}, motion_prompt: #{@motion_prompt.inspect},"\
+      " mute_output_videos: #{@mute_output_videos.inspect}, quality: #{@quality.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end