vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/remix_action10.rb

@@ -0,0 +1,115 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Sharpen every eligible asset in the project up to 4K, replacing each in
+  # place. Runs asynchronously: one upscaled asset is generated per eligible
+  # asset. If the project has no eligible assets, the action is skipped and
+  # completes successfully without changing anything.
+  class RemixAction10 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: UPSCALE_ASSETS
+    # @return [String]
+    attr_reader :type
+
+    # Also upscale video assets (billed per output second). Defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_videos
+
+    # Also upscale stock (library) assets, not just uploaded or generated ones.
+    # Defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_stock_content
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['include_videos'] = 'includeVideos'
+      @_hash['include_stock_content'] = 'includeStockContent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        include_videos
+        include_stock_content
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        include_videos
+        include_stock_content
+      ]
+    end
+
+    def initialize(include_videos: SKIP, include_stock_content: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'UPSCALE_ASSETS'
+      @include_videos = include_videos unless include_videos == SKIP
+      @include_stock_content = include_stock_content unless include_stock_content == 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.
+      include_videos = hash.key?('includeVideos') ? hash['includeVideos'] : SKIP
+      include_stock_content =
+        hash.key?('includeStockContent') ? hash['includeStockContent'] : 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.
+      RemixAction10.new(include_videos: include_videos,
+                        include_stock_content: include_stock_content,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction10 | 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}, include_videos: #{@include_videos}, include_stock_content:"\
+      " #{@include_stock_content}, 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}, include_videos: #{@include_videos.inspect},"\
+      " include_stock_content: #{@include_stock_content.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action11.rb

@@ -0,0 +1,148 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Re-narrate every AI-voiceover asset in the project with a new voice and
+  # optional actor avatar, replacing each narration in place. Runs
+  # asynchronously: text-to-speech is re-fired per asset with the original
+  # narration text. If the project has no AI-narrated assets, the action is
+  # skipped and completes successfully without changing anything.
+  class RemixAction11 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: CHANGE_NARRATOR
+    # @return [String]
+    attr_reader :type
+
+    # Catalog `displayName` (e.g. `Matilda`) or voice id from `GET
+    # /v1/resources/tts-voices` (e.g. `vg_voic_...`) to re-narrate with.
+    # @return [String]
+    attr_accessor :voice_id
+
+    # Recommended. Optional id of a built-in stock actor or an ACTOR entity
+    # (e.g. `vg_enti_...`) with an image reference. When set, narration is
+    # delivered by that actor avatar. Omit or pass `null` for voiceover without
+    # an avatar.
+    # @return [String]
+    attr_accessor :actor_entity_id
+
+    # Avatar generation quality tier. Applies when `actorEntityId` is provided.
+    # Optional; when omitted, your account's Default AI quality for avatars is
+    # used.
+    # @return [ModelQuality3]
+    attr_accessor :avatar_quality
+
+    # Speech rate multiplier, between 0.5 (half speed) and 2 (double speed).
+    # Omit or pass `null` to keep each asset's current speed.
+    # @return [Float]
+    attr_accessor :voice_speed
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['voice_id'] = 'voiceId'
+      @_hash['actor_entity_id'] = 'actorEntityId'
+      @_hash['avatar_quality'] = 'avatarQuality'
+      @_hash['voice_speed'] = 'voiceSpeed'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        actor_entity_id
+        avatar_quality
+        voice_speed
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        actor_entity_id
+        voice_speed
+      ]
+    end
+
+    def initialize(voice_id:, actor_entity_id: SKIP, avatar_quality: SKIP,
+                   voice_speed: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'CHANGE_NARRATOR'
+      @voice_id = voice_id
+      @actor_entity_id = actor_entity_id unless actor_entity_id == SKIP
+      @avatar_quality = avatar_quality unless avatar_quality == SKIP
+      @voice_speed = voice_speed unless voice_speed == 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.
+      voice_id = hash.key?('voiceId') ? hash['voiceId'] : nil
+      actor_entity_id =
+        hash.key?('actorEntityId') ? hash['actorEntityId'] : SKIP
+      avatar_quality = hash.key?('avatarQuality') ? hash['avatarQuality'] : SKIP
+      voice_speed = hash.key?('voiceSpeed') ? hash['voiceSpeed'] : 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.
+      RemixAction11.new(voice_id: voice_id,
+                        actor_entity_id: actor_entity_id,
+                        avatar_quality: avatar_quality,
+                        voice_speed: voice_speed,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction11 | 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.voice_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['voiceId'],
+                                ->(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}, voice_id: #{@voice_id}, actor_entity_id:"\
+      " #{@actor_entity_id}, avatar_quality: #{@avatar_quality}, voice_speed: #{@voice_speed},"\
+      " 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}, voice_id: #{@voice_id.inspect}, actor_entity_id:"\
+      " #{@actor_entity_id.inspect}, avatar_quality: #{@avatar_quality.inspect}, voice_speed:"\
+      " #{@voice_speed.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action12.rb

@@ -0,0 +1,89 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Replace every stock (library) visual in the project with a fresh alternative
+  # from the same search, replacing each in place. Runs asynchronously: each
+  # stock asset's original search is re-run, excluding the currently-shown
+  # result. If the project has no shuffleable stock visuals, the action is
+  # skipped and completes successfully without changing anything.
+  class RemixAction12 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: SHUFFLE_STOCK_VISUALS
+    # @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 = 'SHUFFLE_STOCK_VISUALS'
+      @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.
+      RemixAction12.new(additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction12 | 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_action13.rb

@@ -0,0 +1,105 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Generate a background music track from a text prompt and set it as the
+  # project's background music, replacing any existing track. Runs
+  # asynchronously.
+  class RemixAction13 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: GENERATE_MUSIC
+    # @return [String]
+    attr_reader :type
+
+    # Describe the music to generate (e.g. "upbeat corporate background music
+    # with a driving beat").
+    # @return [String]
+    attr_accessor :prompt
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['prompt'] = 'prompt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prompt:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'GENERATE_MUSIC'
+      @prompt = prompt
+      @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.
+      prompt = hash.key?('prompt') ? hash['prompt'] : 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.
+      RemixAction13.new(prompt: prompt,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction13 | 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.prompt,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['prompt'],
+                                ->(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}, prompt: #{@prompt}, 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}, prompt: #{@prompt.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action14.rb

@@ -0,0 +1,138 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Translate the whole project into another language: every piece of text
+  # (title, section names, on-screen text overlays, transcripts, and narration
+  # scripts) is translated, and — unless disabled — each AI voiceover is
+  # re-narrated in the new language. Runs asynchronously. Requires a Pro
+  # subscription. Retrieve the list of supported language codes from `GET
+  # /v1/resources/languages`.
+  class RemixAction14 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: TRANSLATE_PROJECT
+    # @return [String]
+    attr_reader :type
+
+    # Target language code to translate the project into (e.g. `es`, `fr`,
+    # `ja`). Must be one of the codes returned by `GET /v1/resources/languages`.
+    # @return [String]
+    attr_accessor :language_code
+
+    # Swap each AI voiceover to a voice that natively matches the target
+    # language. Recommended, since keeping the original voice usually produces a
+    # foreign accent. Defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :change_voice
+
+    # Also re-generate every eligible image so that text baked into the image is
+    # translated too (image-to-image). Billed per generated image. Defaults to
+    # `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :translate_image_text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['language_code'] = 'languageCode'
+      @_hash['change_voice'] = 'changeVoice'
+      @_hash['translate_image_text'] = 'translateImageText'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        change_voice
+        translate_image_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        change_voice
+        translate_image_text
+      ]
+    end
+
+    def initialize(language_code:, change_voice: SKIP,
+                   translate_image_text: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'TRANSLATE_PROJECT'
+      @language_code = language_code
+      @change_voice = change_voice unless change_voice == SKIP
+      @translate_image_text = translate_image_text unless translate_image_text == 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.
+      language_code = hash.key?('languageCode') ? hash['languageCode'] : nil
+      change_voice = hash.key?('changeVoice') ? hash['changeVoice'] : SKIP
+      translate_image_text =
+        hash.key?('translateImageText') ? hash['translateImageText'] : 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.
+      RemixAction14.new(language_code: language_code,
+                        change_voice: change_voice,
+                        translate_image_text: translate_image_text,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction14 | 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.language_code,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['languageCode'],
+                                ->(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}, language_code: #{@language_code}, change_voice:"\
+      " #{@change_voice}, translate_image_text: #{@translate_image_text}, 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}, language_code: #{@language_code.inspect},"\
+      " change_voice: #{@change_voice.inspect}, translate_image_text:"\
+      " #{@translate_image_text.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action2.rb

@@ -0,0 +1,101 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Show captions on every captionable section. Optionally override the project
+  # caption style.
+  class RemixAction2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: ENABLE_CAPTIONS
+    # @return [String]
+    attr_reader :type
+
+    # Caption styling to apply. Omit or pass `null` to show captions with the
+    # current style. Any provided field overrides that field; omitted fields
+    # keep their current value.
+    # @return [WorkflowCaptionStyle]
+    attr_accessor :caption_style
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['caption_style'] = 'captionStyle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        caption_style
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        caption_style
+      ]
+    end
+
+    def initialize(caption_style: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'ENABLE_CAPTIONS'
+      @caption_style = caption_style unless caption_style == 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.
+      caption_style = WorkflowCaptionStyle.from_hash(hash['captionStyle']) if hash['captionStyle']
+
+      # 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.
+      RemixAction2.new(caption_style: caption_style,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction2 | 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}, caption_style: #{@caption_style}, 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}, caption_style: #{@caption_style.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end