vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/transcript_word.rb

@@ -0,0 +1,93 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A single timed word of a transcript.
+  class TranscriptWord < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start time of the word in seconds from the beginning of the audio.
+    # @return [Float]
+    attr_accessor :start_seconds
+
+    # End time of the word in seconds from the beginning of the audio. Must be
+    # greater than `startSeconds`.
+    # @return [Float]
+    attr_accessor :end_seconds
+
+    # The spoken word, used verbatim for narration timing and captions.
+    # @return [String]
+    attr_accessor :word
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_seconds'] = 'startSeconds'
+      @_hash['end_seconds'] = 'endSeconds'
+      @_hash['word'] = 'word'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_seconds:, end_seconds:, word:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_seconds = start_seconds
+      @end_seconds = end_seconds
+      @word = word
+      @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.
+      start_seconds = hash.key?('startSeconds') ? hash['startSeconds'] : nil
+      end_seconds = hash.key?('endSeconds') ? hash['endSeconds'] : nil
+      word = hash.key?('word') ? hash['word'] : 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.
+      TranscriptWord.new(start_seconds: start_seconds,
+                         end_seconds: end_seconds,
+                         word: word,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_seconds: #{@start_seconds}, end_seconds: #{@end_seconds}, word:"\
+      " #{@word}, 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} start_seconds: #{@start_seconds.inspect}, end_seconds:"\
+      " #{@end_seconds.inspect}, word: #{@word.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/tts_voice.rb

@@ -0,0 +1,162 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A text-to-speech voice.
+  class TtsVoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Voice id (e.g. `vg_voic_...`). Pass this or `displayName` as `voiceId` to
+    # `POST /v1/tools/text-to-speech`.
+    # @return [String]
+    attr_accessor :voice_id
+
+    # Locale tag for the voice (e.g. `en-US`, `es-ES`).
+    # @return [String]
+    attr_accessor :language_code
+
+    # Human-readable voice name.
+    # @return [String]
+    attr_accessor :display_name
+
+    # Voice gender.
+    # @return [TtsVoiceDisplayGender]
+    attr_accessor :display_gender
+
+    # Accent (e.g. `american`, `british`).
+    # @return [String]
+    attr_accessor :accent
+
+    # Description of the voice.
+    # @return [String]
+    attr_accessor :description
+
+    # When false, this voice cannot be used directly with `POST
+    # /v1/tools/text-to-speech`. All voices, regardless of this field, can be
+    # used in full video generation workflows such as script-to-video.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_direct_tool_execution
+
+    # When true, this voice can synthesize text in any language regardless of
+    # its `languageCode`. When false, the voice only supports its listed
+    # language.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_all_languages
+
+    # When true, this voice is deprecated and may be removed in a future API
+    # version. Prefer non-deprecated voices for new integrations.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_deprecated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['voice_id'] = 'voiceId'
+      @_hash['language_code'] = 'languageCode'
+      @_hash['display_name'] = 'displayName'
+      @_hash['display_gender'] = 'displayGender'
+      @_hash['accent'] = 'accent'
+      @_hash['description'] = 'description'
+      @_hash['supports_direct_tool_execution'] = 'supportsDirectToolExecution'
+      @_hash['supports_all_languages'] = 'supportsAllLanguages'
+      @_hash['is_deprecated'] = 'isDeprecated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accent
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        accent
+        description
+      ]
+    end
+
+    def initialize(voice_id:, language_code:, display_name:, display_gender:,
+                   supports_direct_tool_execution:, supports_all_languages:,
+                   is_deprecated:, accent: SKIP, description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @voice_id = voice_id
+      @language_code = language_code
+      @display_name = display_name
+      @display_gender = display_gender
+      @accent = accent unless accent == SKIP
+      @description = description unless description == SKIP
+      @supports_direct_tool_execution = supports_direct_tool_execution
+      @supports_all_languages = supports_all_languages
+      @is_deprecated = is_deprecated
+      @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
+      language_code = hash.key?('languageCode') ? hash['languageCode'] : nil
+      display_name = hash.key?('displayName') ? hash['displayName'] : nil
+      display_gender = hash.key?('displayGender') ? hash['displayGender'] : nil
+      supports_direct_tool_execution =
+        hash.key?('supportsDirectToolExecution') ? hash['supportsDirectToolExecution'] : nil
+      supports_all_languages =
+        hash.key?('supportsAllLanguages') ? hash['supportsAllLanguages'] : nil
+      is_deprecated = hash.key?('isDeprecated') ? hash['isDeprecated'] : nil
+      accent = hash.key?('accent') ? hash['accent'] : SKIP
+      description = hash.key?('description') ? hash['description'] : 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.
+      TtsVoice.new(voice_id: voice_id,
+                   language_code: language_code,
+                   display_name: display_name,
+                   display_gender: display_gender,
+                   supports_direct_tool_execution: supports_direct_tool_execution,
+                   supports_all_languages: supports_all_languages,
+                   is_deprecated: is_deprecated,
+                   accent: accent,
+                   description: description,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} voice_id: #{@voice_id}, language_code: #{@language_code}, display_name:"\
+      " #{@display_name}, display_gender: #{@display_gender}, accent: #{@accent}, description:"\
+      " #{@description}, supports_direct_tool_execution: #{@supports_direct_tool_execution},"\
+      " supports_all_languages: #{@supports_all_languages}, is_deprecated: #{@is_deprecated},"\
+      " 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} voice_id: #{@voice_id.inspect}, language_code: #{@language_code.inspect},"\
+      " display_name: #{@display_name.inspect}, display_gender: #{@display_gender.inspect},"\
+      " accent: #{@accent.inspect}, description: #{@description.inspect},"\
+      " supports_direct_tool_execution: #{@supports_direct_tool_execution.inspect},"\
+      " supports_all_languages: #{@supports_all_languages.inspect}, is_deprecated:"\
+      " #{@is_deprecated.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/tts_voice_display_gender.rb

@@ -0,0 +1,40 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Voice gender.
+  class TtsVoiceDisplayGender
+    TTS_VOICE_DISPLAY_GENDER = [
+      # TODO: Write general description for MALE
+      MALE = 'MALE'.freeze,
+
+      # TODO: Write general description for FEMALE
+      FEMALE = 'FEMALE'.freeze,
+
+      # TODO: Write general description for NEUTRAL
+      NEUTRAL = 'NEUTRAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TTS_VOICE_DISPLAY_GENDER.include?(value)
+    end
+
+    def self.from_value(value, default_value = MALE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'male' then MALE
+      when 'female' then FEMALE
+      when 'neutral' then NEUTRAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/tts_voice_list_response.rb

@@ -0,0 +1,103 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # TtsVoiceListResponse Model.
+  class TtsVoiceListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TtsVoice]]
+    attr_accessor :tts_voices
+
+    # When true, there are more voices available. Pass `nextCursor` as the
+    # `cursor` query param to fetch the next page.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # Opaque cursor to fetch the next page. `null` when `hasMore` is false.
+    # @return [String]
+    attr_accessor :next_cursor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tts_voices'] = 'ttsVoices'
+      @_hash['has_more'] = 'hasMore'
+      @_hash['next_cursor'] = 'nextCursor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        next_cursor
+      ]
+    end
+
+    def initialize(tts_voices:, has_more:, next_cursor:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tts_voices = tts_voices
+      @has_more = has_more
+      @next_cursor = next_cursor
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      tts_voices = nil
+      unless hash['ttsVoices'].nil?
+        tts_voices = []
+        hash['ttsVoices'].each do |structure|
+          tts_voices << (TtsVoice.from_hash(structure) if structure)
+        end
+      end
+
+      tts_voices = nil unless hash.key?('ttsVoices')
+      has_more = hash.key?('hasMore') ? hash['hasMore'] : nil
+      next_cursor = hash.key?('nextCursor') ? hash['nextCursor'] : 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.
+      TtsVoiceListResponse.new(tts_voices: tts_voices,
+                               has_more: has_more,
+                               next_cursor: next_cursor,
+                               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tts_voices: #{@tts_voices}, has_more: #{@has_more}, next_cursor:"\
+      " #{@next_cursor}, 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} tts_voices: #{@tts_voices.inspect}, has_more: #{@has_more.inspect},"\
+      " next_cursor: #{@next_cursor.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/update_entity_request.rb

@@ -0,0 +1,88 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # At least one field must be provided.
+  class UpdateEntityRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # New display name. Omit to leave unchanged.
+    # @return [String]
+    attr_accessor :name
+
+    # New description. Omit to leave unchanged.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        name
+        description
+      ]
+    end
+
+    def initialize(name: SKIP, description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @description = description unless description == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : 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.
+      UpdateEntityRequest.new(name: name,
+                              description: description,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, description: #{@description}, 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} name: #{@name.inspect}, description: #{@description.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/v1_entities_get_parameters_entity_type.rb

@@ -0,0 +1,44 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # V1EntitiesGetParametersEntityType.
+  class V1EntitiesGetParametersEntityType
+    V1_ENTITIES_GET_PARAMETERS_ENTITY_TYPE = [
+      # TODO: Write general description for ACTOR
+      ACTOR = 'ACTOR'.freeze,
+
+      # TODO: Write general description for PRODUCT
+      PRODUCT = 'PRODUCT'.freeze,
+
+      # TODO: Write general description for VISUAL_STYLE
+      VISUAL_STYLE = 'VISUAL_STYLE'.freeze,
+
+      # TODO: Write general description for SLIDESHOW_THEME
+      SLIDESHOW_THEME = 'SLIDESHOW_THEME'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      V1_ENTITIES_GET_PARAMETERS_ENTITY_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTOR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'actor' then ACTOR
+      when 'product' then PRODUCT
+      when 'visual_style' then VISUAL_STYLE
+      when 'slideshow_theme' then SLIDESHOW_THEME
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/video_asset_request.rb

@@ -0,0 +1,125 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # VideoAssetRequest Model.
+  class VideoAssetRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # File id of the source video (e.g. `vg_file_...`). Upload a file first via
+    # `POST /v1/files/upload`, then pass the returned id here.
+    # @return [String]
+    attr_accessor :video_file_id
+
+    # Controls whether the VideoGen watermark is applied to the output. `AUTO`
+    # applies the watermark unless you have a Pro plan. `VIDEO_GEN` always
+    # applies it. `NONE` removes the watermark (requires Pro; returns an error
+    # if you don't have it).
+    # @return [WatermarkMode]
+    attr_accessor :watermark_mode
+
+    # Number of output results to generate. Defaults to 1.
+    # @return [Integer]
+    attr_accessor :num_results
+
+    # When true, generated files are temporary. Temporary files are guaranteed
+    # to be available for 24 hours, after which they may be archived at any
+    # time. Temporary files are not analyzed (no description, transcript, or
+    # embedding will be generated), so they will not appear in search results.
+    # Defaults to false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_output_temporary
+
+    # When true, generated files are hidden from the VideoGen Media page by
+    # default. They remain accessible through the API. Defaults to false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :hide_from_ui
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['video_file_id'] = 'videoFileId'
+      @_hash['watermark_mode'] = 'watermarkMode'
+      @_hash['num_results'] = 'numResults'
+      @_hash['is_output_temporary'] = 'isOutputTemporary'
+      @_hash['hide_from_ui'] = 'hideFromUi'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        watermark_mode
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(video_file_id:, watermark_mode: WatermarkMode::AUTO,
+                   num_results: 1, is_output_temporary: false,
+                   hide_from_ui: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @video_file_id = video_file_id
+      @watermark_mode = watermark_mode unless watermark_mode == SKIP
+      @num_results = num_results unless num_results == SKIP
+      @is_output_temporary = is_output_temporary unless is_output_temporary == SKIP
+      @hide_from_ui = hide_from_ui unless hide_from_ui == 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.
+      video_file_id = hash.key?('videoFileId') ? hash['videoFileId'] : nil
+      watermark_mode = hash['watermarkMode'] ||= WatermarkMode::AUTO
+      num_results = hash['numResults'] ||= 1
+      is_output_temporary = hash['isOutputTemporary'] ||= false
+      hide_from_ui = hash['hideFromUi'] ||= false
+
+      # 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.
+      VideoAssetRequest.new(video_file_id: video_file_id,
+                            watermark_mode: watermark_mode,
+                            num_results: num_results,
+                            is_output_temporary: is_output_temporary,
+                            hide_from_ui: hide_from_ui,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} video_file_id: #{@video_file_id}, watermark_mode: #{@watermark_mode},"\
+      " num_results: #{@num_results}, is_output_temporary: #{@is_output_temporary}, hide_from_ui:"\
+      " #{@hide_from_ui}, 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} video_file_id: #{@video_file_id.inspect}, watermark_mode:"\
+      " #{@watermark_mode.inspect}, num_results: #{@num_results.inspect}, is_output_temporary:"\
+      " #{@is_output_temporary.inspect}, hide_from_ui: #{@hide_from_ui.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/visual_pacing.rb

@@ -0,0 +1,41 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # How quickly visuals change. FAST shows more, shorter shots; SLOW holds each
+  # visual longer. Defaults to MEDIUM.
+  class VisualPacing
+    VISUAL_PACING = [
+      # TODO: Write general description for FAST
+      FAST = 'FAST'.freeze,
+
+      # TODO: Write general description for MEDIUM
+      MEDIUM = 'MEDIUM'.freeze,
+
+      # TODO: Write general description for SLOW
+      SLOW = 'SLOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VISUAL_PACING.include?(value)
+    end
+
+    def self.from_value(value, default_value = FAST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fast' then FAST
+      when 'medium' then MEDIUM
+      when 'slow' then SLOW
+      else
+        default_value
+      end
+    end
+  end
+end