vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/file_type1.rb

@@ -0,0 +1,56 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # File type.
+  class FileType1
+    FILE_TYPE1 = [
+      # TODO: Write general description for IMAGE
+      IMAGE = 'IMAGE'.freeze,
+
+      # TODO: Write general description for VIDEO
+      VIDEO = 'VIDEO'.freeze,
+
+      # TODO: Write general description for AUDIO
+      AUDIO = 'AUDIO'.freeze,
+
+      # TODO: Write general description for PDF
+      PDF = 'PDF'.freeze,
+
+      # TODO: Write general description for SLIDESHOW
+      SLIDESHOW = 'SLIDESHOW'.freeze,
+
+      # TODO: Write general description for TEXT
+      TEXT = 'TEXT'.freeze,
+
+      # TODO: Write general description for LOTTIE
+      LOTTIE = 'LOTTIE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILE_TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = IMAGE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'image' then IMAGE
+      when 'video' then VIDEO
+      when 'audio' then AUDIO
+      when 'pdf' then PDF
+      when 'slideshow' then SLIDESHOW
+      when 'text' then TEXT
+      when 'lottie' then LOTTIE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/file_type2.rb

@@ -0,0 +1,57 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # The type of file to upload. Optional; when omitted, the type is inferred
+  # after upload processing completes.
+  class FileType2
+    FILE_TYPE2 = [
+      # TODO: Write general description for IMAGE
+      IMAGE = 'IMAGE'.freeze,
+
+      # TODO: Write general description for VIDEO
+      VIDEO = 'VIDEO'.freeze,
+
+      # TODO: Write general description for AUDIO
+      AUDIO = 'AUDIO'.freeze,
+
+      # TODO: Write general description for PDF
+      PDF = 'PDF'.freeze,
+
+      # TODO: Write general description for SLIDESHOW
+      SLIDESHOW = 'SLIDESHOW'.freeze,
+
+      # TODO: Write general description for TEXT
+      TEXT = 'TEXT'.freeze,
+
+      # TODO: Write general description for LOTTIE
+      LOTTIE = 'LOTTIE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILE_TYPE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = IMAGE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'image' then IMAGE
+      when 'video' then VIDEO
+      when 'audio' then AUDIO
+      when 'pdf' then PDF
+      when 'slideshow' then SLIDESHOW
+      when 'text' then TEXT
+      when 'lottie' then LOTTIE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/file_upload_response.rb

@@ -0,0 +1,82 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # FileUploadResponse Model.
+  class FileUploadResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The file id to use in subsequent API calls (e.g. `vg_file_...`).
+    # @return [String]
+    attr_accessor :file_id
+
+    # Pre-signed URL. PUT the raw file bytes to this URL to complete the upload.
+    # @return [String]
+    attr_accessor :upload_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_id'] = 'fileId'
+      @_hash['upload_url'] = 'uploadUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(file_id:, upload_url:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @file_id = file_id
+      @upload_url = upload_url
+      @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.
+      file_id = hash.key?('fileId') ? hash['fileId'] : nil
+      upload_url = hash.key?('uploadUrl') ? hash['uploadUrl'] : 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.
+      FileUploadResponse.new(file_id: file_id,
+                             upload_url: upload_url,
+                             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} file_id: #{@file_id}, upload_url: #{@upload_url}, 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} file_id: #{@file_id.inspect}, upload_url: #{@upload_url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/generate_avatar_request.rb

@@ -0,0 +1,149 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Generate a talking-head avatar from an ACTOR entity and audio.
+  class GenerateAvatarRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of a built-in stock actor or an ACTOR entity (e.g. `vg_enti_...`)
+    # with an image reference.
+    # @return [String]
+    attr_accessor :actor_entity_id
+
+    # Avatar generation quality tier. Optional; when omitted, your account's
+    # Default AI quality for avatars is used.
+    # @return [ModelQuality12]
+    attr_accessor :avatar_quality
+
+    # File id of an AUDIO file (e.g. `vg_file_...`), typically from a prior
+    # text-to-speech result. Upload a file first via `POST /v1/files/upload` or
+    # generate one with `POST /v1/tools/text-to-speech`, then pass the returned
+    # id here.
+    # @return [String]
+    attr_accessor :audio_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['actor_entity_id'] = 'actorEntityId'
+      @_hash['avatar_quality'] = 'avatarQuality'
+      @_hash['audio_file_id'] = 'audioFileId'
+      @_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[
+        avatar_quality
+        watermark_mode
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(actor_entity_id:, audio_file_id:, avatar_quality: SKIP,
+                   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?
+
+      @actor_entity_id = actor_entity_id
+      @avatar_quality = avatar_quality unless avatar_quality == SKIP
+      @audio_file_id = audio_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.
+      actor_entity_id = hash.key?('actorEntityId') ? hash['actorEntityId'] : nil
+      audio_file_id = hash.key?('audioFileId') ? hash['audioFileId'] : nil
+      avatar_quality = hash.key?('avatarQuality') ? hash['avatarQuality'] : SKIP
+      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.
+      GenerateAvatarRequest.new(actor_entity_id: actor_entity_id,
+                                audio_file_id: audio_file_id,
+                                avatar_quality: avatar_quality,
+                                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} actor_entity_id: #{@actor_entity_id}, avatar_quality: #{@avatar_quality},"\
+      " audio_file_id: #{@audio_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} actor_entity_id: #{@actor_entity_id.inspect}, avatar_quality:"\
+      " #{@avatar_quality.inspect}, audio_file_id: #{@audio_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/generate_image_request.rb

@@ -0,0 +1,187 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # GenerateImageRequest Model.
+  class GenerateImageRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Text prompt describing the image to generate. When reference images are
+    # provided, the prompt describes the desired transformation.
+    # @return [String]
+    attr_accessor :prompt
+
+    # Optional file ids of reference images (e.g. `["vg_file_..."]`). Upload
+    # files first via `POST /v1/files/upload`, then pass the returned ids here.
+    # Maximum 4 images. When provided, the model uses these as guidance for
+    # generation.
+    # @return [Array[String]]
+    attr_accessor :image_file_ids
+
+    # Optional actor, product, or visual-style entity ids (e.g.
+    # `["vg_enti_..."]`). The model uses each entity as identity/reference the
+    # same way in-app image generation does. Can be combined with
+    # `imageFileIds`. A missing id returns not found; an inaccessible id returns
+    # a permission error.
+    # @return [Array[String]]
+    attr_accessor :entity_ids
+
+    # Aspect ratio for the generated image. Defaults to 16:9 when omitted.
+    # @return [AspectRatio2]
+    attr_accessor :aspect_ratio
+
+    # Image generation quality tier. Optional; when omitted, your account's
+    # Default AI quality for images is used (change it at
+    # https://app.videogen.io/settings/account).
+    # @return [ModelQuality10]
+    attr_accessor :quality
+
+    # Controls how content-policy rejections are handled during generation.
+    # @return [ContentPolicyConfig]
+    attr_accessor :content_policy_config
+
+    # 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['prompt'] = 'prompt'
+      @_hash['image_file_ids'] = 'imageFileIds'
+      @_hash['entity_ids'] = 'entityIds'
+      @_hash['aspect_ratio'] = 'aspectRatio'
+      @_hash['quality'] = 'quality'
+      @_hash['content_policy_config'] = 'contentPolicyConfig'
+      @_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[
+        image_file_ids
+        entity_ids
+        aspect_ratio
+        quality
+        content_policy_config
+        watermark_mode
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prompt:, image_file_ids: SKIP, entity_ids: SKIP,
+                   aspect_ratio: SKIP, quality: SKIP,
+                   content_policy_config: SKIP,
+                   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?
+
+      @prompt = prompt
+      @image_file_ids = image_file_ids unless image_file_ids == SKIP
+      @entity_ids = entity_ids unless entity_ids == SKIP
+      @aspect_ratio = aspect_ratio unless aspect_ratio == SKIP
+      @quality = quality unless quality == SKIP
+      @content_policy_config = content_policy_config unless content_policy_config == SKIP
+      @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.
+      prompt = hash.key?('prompt') ? hash['prompt'] : nil
+      image_file_ids = hash.key?('imageFileIds') ? hash['imageFileIds'] : SKIP
+      entity_ids = hash.key?('entityIds') ? hash['entityIds'] : SKIP
+      aspect_ratio = AspectRatio2.from_hash(hash['aspectRatio']) if hash['aspectRatio']
+      quality = hash.key?('quality') ? hash['quality'] : SKIP
+      content_policy_config = ContentPolicyConfig.from_hash(hash['contentPolicyConfig']) if
+        hash['contentPolicyConfig']
+      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.
+      GenerateImageRequest.new(prompt: prompt,
+                               image_file_ids: image_file_ids,
+                               entity_ids: entity_ids,
+                               aspect_ratio: aspect_ratio,
+                               quality: quality,
+                               content_policy_config: content_policy_config,
+                               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} prompt: #{@prompt}, image_file_ids: #{@image_file_ids}, entity_ids:"\
+      " #{@entity_ids}, aspect_ratio: #{@aspect_ratio}, quality: #{@quality},"\
+      " content_policy_config: #{@content_policy_config}, 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} prompt: #{@prompt.inspect}, image_file_ids: #{@image_file_ids.inspect},"\
+      " entity_ids: #{@entity_ids.inspect}, aspect_ratio: #{@aspect_ratio.inspect}, quality:"\
+      " #{@quality.inspect}, content_policy_config: #{@content_policy_config.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