vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/generate_motion_graphic_request.rb

@@ -0,0 +1,193 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # GenerateMotionGraphicRequest Model.
+  class GenerateMotionGraphicRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Text prompt describing the animated motion graphic to generate. Describe
+    # the on-screen elements, any text and how it should animate, and the
+    # overall motion in plain language.
+    # @return [String]
+    attr_accessor :prompt
+
+    # Optional file ids of uploaded reference media (images, videos, or audio)
+    # the motion graphic may display or animate (e.g. `["vg_file_..."]`). Upload
+    # files first via `POST /v1/files/upload`, then pass the returned ids here.
+    # @return [Array[String]]
+    attr_accessor :file_ids
+
+    # Optional actor, product, or visual-style entity ids (e.g.
+    # `["vg_enti_..."]`). The motion graphic uses each entity as
+    # identity/reference the same way in-app motion graphic generation does. Can
+    # be combined with `fileIds`. Mentions in `prompt` are also collected. A
+    # missing id returns not found; an inaccessible id returns a permission
+    # error.
+    # @return [Array[String]]
+    attr_accessor :entity_ids
+
+    # Desired length of the motion graphic in seconds, a whole number between 1
+    # and 300. When omitted, the duration is chosen automatically to fit the
+    # prompt (recommended).
+    # @return [Integer]
+    attr_accessor :duration_seconds
+
+    # Aspect ratio for the generated motion graphic. Defaults to 16:9 when
+    # omitted.
+    # @return [AspectRatio4]
+    attr_accessor :aspect_ratio
+
+    # When true, renders the motion graphic with a transparent background as a
+    # WebM video suitable for overlaying on other video or images. Set to false
+    # for an opaque MP4. Defaults to true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transparent_background
+
+    # Optional per-capability controls for the media the motion graphic may
+    # generate or fetch (generated images, generated video clips, generated
+    # voiceover, and stock media search). Each capability is AUTO, ENABLED, or
+    # DISABLED. Omit to use AUTO for every capability.
+    # @return [MotionGraphicSubToolModes1]
+    attr_accessor :sub_tool_modes
+
+    # 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['file_ids'] = 'fileIds'
+      @_hash['entity_ids'] = 'entityIds'
+      @_hash['duration_seconds'] = 'durationSeconds'
+      @_hash['aspect_ratio'] = 'aspectRatio'
+      @_hash['transparent_background'] = 'transparentBackground'
+      @_hash['sub_tool_modes'] = 'subToolModes'
+      @_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[
+        file_ids
+        entity_ids
+        duration_seconds
+        aspect_ratio
+        transparent_background
+        sub_tool_modes
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        duration_seconds
+      ]
+    end
+
+    def initialize(prompt:, file_ids: SKIP, entity_ids: SKIP,
+                   duration_seconds: SKIP, aspect_ratio: SKIP,
+                   transparent_background: true, sub_tool_modes: SKIP,
+                   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
+      @file_ids = file_ids unless file_ids == SKIP
+      @entity_ids = entity_ids unless entity_ids == SKIP
+      @duration_seconds = duration_seconds unless duration_seconds == SKIP
+      @aspect_ratio = aspect_ratio unless aspect_ratio == SKIP
+      @transparent_background = transparent_background unless transparent_background == SKIP
+      @sub_tool_modes = sub_tool_modes unless sub_tool_modes == 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
+      file_ids = hash.key?('fileIds') ? hash['fileIds'] : SKIP
+      entity_ids = hash.key?('entityIds') ? hash['entityIds'] : SKIP
+      duration_seconds =
+        hash.key?('durationSeconds') ? hash['durationSeconds'] : SKIP
+      aspect_ratio = AspectRatio4.from_hash(hash['aspectRatio']) if hash['aspectRatio']
+      transparent_background = hash['transparentBackground'] ||= true
+      sub_tool_modes = MotionGraphicSubToolModes1.from_hash(hash['subToolModes']) if
+        hash['subToolModes']
+      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.
+      GenerateMotionGraphicRequest.new(prompt: prompt,
+                                       file_ids: file_ids,
+                                       entity_ids: entity_ids,
+                                       duration_seconds: duration_seconds,
+                                       aspect_ratio: aspect_ratio,
+                                       transparent_background: transparent_background,
+                                       sub_tool_modes: sub_tool_modes,
+                                       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}, file_ids: #{@file_ids}, entity_ids: #{@entity_ids},"\
+      " duration_seconds: #{@duration_seconds}, aspect_ratio: #{@aspect_ratio},"\
+      " transparent_background: #{@transparent_background}, sub_tool_modes: #{@sub_tool_modes},"\
+      " 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}, file_ids: #{@file_ids.inspect}, entity_ids:"\
+      " #{@entity_ids.inspect}, duration_seconds: #{@duration_seconds.inspect}, aspect_ratio:"\
+      " #{@aspect_ratio.inspect}, transparent_background: #{@transparent_background.inspect},"\
+      " sub_tool_modes: #{@sub_tool_modes.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_music_request.rb

@@ -0,0 +1,111 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # GenerateMusicRequest Model.
+  class GenerateMusicRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A text description of the music to generate. Include genre, mood,
+    # instrumentation, and tempo for best results.
+    # @return [String]
+    attr_accessor :prompt
+
+    # 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['num_results'] = 'numResults'
+      @_hash['is_output_temporary'] = 'isOutputTemporary'
+      @_hash['hide_from_ui'] = 'hideFromUi'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prompt:, 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
+      @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
+      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.
+      GenerateMusicRequest.new(prompt: prompt,
+                               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}, 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}, 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_sound_effect_request.rb

@@ -0,0 +1,139 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # GenerateSoundEffectRequest Model.
+  class GenerateSoundEffectRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A text description of the sound effect to generate.
+    # @return [String]
+    attr_accessor :prompt
+
+    # Desired length of the sound effect in seconds, between 1 and 30. Defaults
+    # to about 10 seconds when omitted.
+    # @return [Float]
+    attr_accessor :duration_seconds
+
+    # How closely the generated sound effect follows the prompt, between 0 (more
+    # creative, more variation) and 1 (more literal, less variation). Defaults
+    # to a balanced value when omitted.
+    # @return [Float]
+    attr_accessor :prompt_influence
+
+    # 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['duration_seconds'] = 'durationSeconds'
+      @_hash['prompt_influence'] = 'promptInfluence'
+      @_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[
+        duration_seconds
+        prompt_influence
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        duration_seconds
+        prompt_influence
+      ]
+    end
+
+    def initialize(prompt:, duration_seconds: SKIP, prompt_influence: SKIP,
+                   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
+      @duration_seconds = duration_seconds unless duration_seconds == SKIP
+      @prompt_influence = prompt_influence unless prompt_influence == 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
+      duration_seconds =
+        hash.key?('durationSeconds') ? hash['durationSeconds'] : SKIP
+      prompt_influence =
+        hash.key?('promptInfluence') ? hash['promptInfluence'] : SKIP
+      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.
+      GenerateSoundEffectRequest.new(prompt: prompt,
+                                     duration_seconds: duration_seconds,
+                                     prompt_influence: prompt_influence,
+                                     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}, duration_seconds: #{@duration_seconds},"\
+      " prompt_influence: #{@prompt_influence}, 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}, duration_seconds: #{@duration_seconds.inspect},"\
+      " prompt_influence: #{@prompt_influence.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_text_request.rb

@@ -0,0 +1,120 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # GenerateTextRequest Model.
+  class GenerateTextRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The instruction or content to generate text from.
+    # @return [String]
+    attr_accessor :prompt
+
+    # Optional system instructions that steer the model's role, tone, and
+    # constraints.
+    # @return [String]
+    attr_accessor :system
+
+    # Text generation quality tier. Optional; when omitted, your account's
+    # Default AI quality for text is used (change it at
+    # https://app.videogen.io/settings/account).
+    # @return [ModelQuality13]
+    attr_accessor :quality
+
+    # Sampling temperature. Higher values produce more varied output. Defaults
+    # to the model's default.
+    # @return [Float]
+    attr_accessor :temperature
+
+    # Maximum number of tokens to generate. Defaults to 512.
+    # @return [Integer]
+    attr_accessor :max_output_tokens
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prompt'] = 'prompt'
+      @_hash['system'] = 'system'
+      @_hash['quality'] = 'quality'
+      @_hash['temperature'] = 'temperature'
+      @_hash['max_output_tokens'] = 'maxOutputTokens'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        system
+        quality
+        temperature
+        max_output_tokens
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        system
+      ]
+    end
+
+    def initialize(prompt:, system: SKIP, quality: SKIP, temperature: SKIP,
+                   max_output_tokens: 512, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @prompt = prompt
+      @system = system unless system == SKIP
+      @quality = quality unless quality == SKIP
+      @temperature = temperature unless temperature == SKIP
+      @max_output_tokens = max_output_tokens unless max_output_tokens == 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
+      system = hash.key?('system') ? hash['system'] : SKIP
+      quality = hash.key?('quality') ? hash['quality'] : SKIP
+      temperature = hash.key?('temperature') ? hash['temperature'] : SKIP
+      max_output_tokens = hash['maxOutputTokens'] ||= 512
+
+      # 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.
+      GenerateTextRequest.new(prompt: prompt,
+                              system: system,
+                              quality: quality,
+                              temperature: temperature,
+                              max_output_tokens: max_output_tokens,
+                              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}, system: #{@system}, quality: #{@quality}, temperature:"\
+      " #{@temperature}, max_output_tokens: #{@max_output_tokens}, 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}, system: #{@system.inspect}, quality:"\
+      " #{@quality.inspect}, temperature: #{@temperature.inspect}, max_output_tokens:"\
+      " #{@max_output_tokens.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/generate_text_response.rb

@@ -0,0 +1,72 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # GenerateTextResponse Model.
+  class GenerateTextResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The generated text.
+    # @return [String]
+    attr_accessor :text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['text'] = 'text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(text:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @text = text
+      @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.
+      text = hash.key?('text') ? hash['text'] : 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.
+      GenerateTextResponse.new(text: text,
+                               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} text: #{@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} text: #{@text.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end