vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/project_response.rb

@@ -0,0 +1,151 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Simplified project metadata.
+  class ProjectResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque project id (e.g. `vg_proj_...`).
+    # @return [String]
+    attr_accessor :project_id
+
+    # Opaque id of this project's assistant conversation (e.g. `vg_asst_...`).
+    # Use with the Assistant API to send follow-up messages or list the
+    # assistant's prior messages for this project. `null` for older projects
+    # created before assistant chats were attached at creation time.
+    # @return [String]
+    attr_accessor :assistant_id
+
+    # Opaque id of this project's assistant conversation (e.g. `vg_asst_...`).
+    # Use with the Assistant API to send follow-up messages or list the
+    # assistant's prior messages for this project. `null` for older projects
+    # created before assistant chats were attached at creation time.
+    # @return [String]
+    attr_accessor :title
+
+    # Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel
+    # dimensions.
+    # @return [AspectRatio]
+    attr_accessor :aspect_ratio
+
+    # High-level project status.
+    # @return [ProjectResponseStatus]
+    attr_accessor :status
+
+    # Seconds since epoch (Unix timestamp) when the project was created.
+    # @return [Integer]
+    attr_accessor :created_at
+
+    # Seconds since epoch (Unix timestamp) when the project was last updated.
+    # @return [Integer]
+    attr_accessor :updated_at
+
+    # Deep link to open this project in the VideoGen web editor. Not required
+    # for an API-only integration: store `projectId` and use the Projects API
+    # (export, remix, metadata). Use `projectUrl` when a person should open the
+    # project in the app to review or edit it manually. The project is visible
+    # only to members of your team and any project collaborators, the same
+    # access model as a project created in the dashboard.
+    # @return [String]
+    attr_accessor :project_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['project_id'] = 'projectId'
+      @_hash['assistant_id'] = 'assistantId'
+      @_hash['title'] = 'title'
+      @_hash['aspect_ratio'] = 'aspectRatio'
+      @_hash['status'] = 'status'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['updated_at'] = 'updatedAt'
+      @_hash['project_url'] = 'projectUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        assistant_id
+      ]
+    end
+
+    def initialize(project_id:, assistant_id:, title:, aspect_ratio:, status:,
+                   created_at:, updated_at:, project_url:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @project_id = project_id
+      @assistant_id = assistant_id
+      @title = title
+      @aspect_ratio = aspect_ratio
+      @status = status
+      @created_at = created_at
+      @updated_at = updated_at
+      @project_url = project_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.
+      project_id = hash.key?('projectId') ? hash['projectId'] : nil
+      assistant_id = hash.key?('assistantId') ? hash['assistantId'] : nil
+      title = hash.key?('title') ? hash['title'] : nil
+      aspect_ratio = AspectRatio.from_hash(hash['aspectRatio']) if hash['aspectRatio']
+      status = hash.key?('status') ? hash['status'] : nil
+      created_at = hash.key?('createdAt') ? hash['createdAt'] : nil
+      updated_at = hash.key?('updatedAt') ? hash['updatedAt'] : nil
+      project_url = hash.key?('projectUrl') ? hash['projectUrl'] : 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.
+      ProjectResponse.new(project_id: project_id,
+                          assistant_id: assistant_id,
+                          title: title,
+                          aspect_ratio: aspect_ratio,
+                          status: status,
+                          created_at: created_at,
+                          updated_at: updated_at,
+                          project_url: project_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} project_id: #{@project_id}, assistant_id: #{@assistant_id}, title:"\
+      " #{@title}, aspect_ratio: #{@aspect_ratio}, status: #{@status}, created_at: #{@created_at},"\
+      " updated_at: #{@updated_at}, project_url: #{@project_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} project_id: #{@project_id.inspect}, assistant_id: #{@assistant_id.inspect},"\
+      " title: #{@title.inspect}, aspect_ratio: #{@aspect_ratio.inspect}, status:"\
+      " #{@status.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, project_url: #{@project_url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/project_response_status.rb

@@ -0,0 +1,36 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # High-level project status.
+  class ProjectResponseStatus
+    PROJECT_RESPONSE_STATUS = [
+      # TODO: Write general description for GENERATING
+      GENERATING = 'generating'.freeze,
+
+      # TODO: Write general description for READY
+      READY = 'ready'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROJECT_RESPONSE_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = GENERATING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'generating' then GENERATING
+      when 'ready' then READY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/prompt_to_video_clip_request.rb

@@ -0,0 +1,155 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Creates a project from a text prompt and generates one short AI video clip.
+  # VideoGen generates an opening frame from the prompt (optionally guided by
+  # reference images), then animates that frame into a video inside an editable
+  # project. This workflow does not accept `remixActions`. For a standalone clip
+  # without a project, use `POST /v1/tools/generate-video-clip`. For longer
+  # narrated multi-scene videos, use `POST /v1/workflows/script-to-video`.
+  class PromptToVideoClipRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Text prompt describing the video to generate (e.g. `A golden retriever
+    # running through a sunlit meadow in slow motion, cinematic`).
+    # @return [String]
+    attr_accessor :prompt
+
+    # Optional ids of previously uploaded reference images (e.g. `vg_file_...`)
+    # that guide the opening frame. Upload files via `POST /v1/files/upload`
+    # first.
+    # @return [Array[String]]
+    attr_accessor :image_file_ids
+
+    # Desired clip length in whole seconds (1 to 30). Defaults to 10. The
+    # generated clip is clamped to the selected quality's supported range.
+    # @return [Integer]
+    attr_accessor :duration_seconds
+
+    # Aspect ratio for the generated video. Defaults to 16:9 when omitted.
+    # @return [AspectRatio1]
+    attr_accessor :aspect_ratio
+
+    # Video generation quality tier (`LOW`, `STANDARD`, `HIGH`, or `MAX`). Also
+    # used for the opening-frame image. Optional; when omitted, your account's
+    # Default AI quality for video is used (change it at
+    # https://app.videogen.io/settings/account).
+    # @return [ModelQuality9]
+    attr_accessor :quality
+
+    # When true, the generated OUTPUT files (the opening-frame image and the
+    # video clip) are created as temporary: guaranteed available for 24 hours,
+    # after which they may be archived and later deleted. Use this when your
+    # integration downloads or re-hosts the results itself and does not need
+    # VideoGen to retain them. The project and its metadata are unaffected.
+    # 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['duration_seconds'] = 'durationSeconds'
+      @_hash['aspect_ratio'] = 'aspectRatio'
+      @_hash['quality'] = 'quality'
+      @_hash['is_output_temporary'] = 'isOutputTemporary'
+      @_hash['hide_from_ui'] = 'hideFromUi'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        image_file_ids
+        duration_seconds
+        aspect_ratio
+        quality
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prompt:, image_file_ids: SKIP, duration_seconds: SKIP,
+                   aspect_ratio: SKIP, quality: SKIP,
+                   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
+      @duration_seconds = duration_seconds unless duration_seconds == SKIP
+      @aspect_ratio = aspect_ratio unless aspect_ratio == SKIP
+      @quality = quality unless quality == 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
+      duration_seconds =
+        hash.key?('durationSeconds') ? hash['durationSeconds'] : SKIP
+      aspect_ratio = AspectRatio1.from_hash(hash['aspectRatio']) if hash['aspectRatio']
+      quality = hash.key?('quality') ? hash['quality'] : SKIP
+      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.
+      PromptToVideoClipRequest.new(prompt: prompt,
+                                   image_file_ids: image_file_ids,
+                                   duration_seconds: duration_seconds,
+                                   aspect_ratio: aspect_ratio,
+                                   quality: quality,
+                                   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}, duration_seconds:"\
+      " #{@duration_seconds}, aspect_ratio: #{@aspect_ratio}, quality: #{@quality},"\
+      " 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},"\
+      " duration_seconds: #{@duration_seconds.inspect}, aspect_ratio: #{@aspect_ratio.inspect},"\
+      " quality: #{@quality.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/pronunciation_replacement.rb

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

data/lib/videogen/models/remix_action.rb

@@ -0,0 +1,111 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Set, replace, or remove the project's background music track.
+  class RemixAction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: SET_BACKGROUND_MUSIC
+    # @return [String]
+    attr_reader :type
+
+    # File id of an uploaded audio file to use as background music (e.g.
+    # `vg_file_...`). Upload it first via `POST /v1/files/upload`. Pass `null`
+    # to remove the existing background music.
+    # @return [String]
+    attr_accessor :file_id
+
+    # Music volume from 0 (silent) to 1 (full). Omit or pass `null` to keep the
+    # current volume.
+    # @return [Float]
+    attr_accessor :volume
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['file_id'] = 'fileId'
+      @_hash['volume'] = 'volume'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        file_id
+        volume
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        file_id
+        volume
+      ]
+    end
+
+    def initialize(file_id: SKIP, volume: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'SET_BACKGROUND_MUSIC'
+      @file_id = file_id unless file_id == SKIP
+      @volume = volume unless volume == 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.
+      file_id = hash.key?('fileId') ? hash['fileId'] : SKIP
+      volume = hash.key?('volume') ? hash['volume'] : 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.
+      RemixAction.new(file_id: file_id,
+                      volume: volume,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction | 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}, file_id: #{@file_id}, volume: #{@volume},"\
+      " 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}, file_id: #{@file_id.inspect}, volume:"\
+      " #{@volume.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action1.rb

@@ -0,0 +1,123 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Set, replace, or remove the logo overlay.
+  class RemixAction1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: SET_LOGO
+    # @return [String]
+    attr_reader :type
+
+    # File id of an uploaded image to overlay as a logo (e.g. `vg_file_...`).
+    # Upload it first via `POST /v1/files/upload`. Pass `null` to remove the
+    # existing logo.
+    # @return [String]
+    attr_accessor :file_id
+
+    # Position the logo is anchored to. Omit or pass `null` to keep the current
+    # position.
+    # @return [RemixActionDiscriminatorMappingSetLogoPosition]
+    attr_accessor :position
+
+    # Logo width as a percentage of the video width. Omit or pass `null` to keep
+    # the current size.
+    # @return [Float]
+    attr_accessor :size_percent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['file_id'] = 'fileId'
+      @_hash['position'] = 'position'
+      @_hash['size_percent'] = 'sizePercent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        file_id
+        position
+        size_percent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        file_id
+        size_percent
+      ]
+    end
+
+    def initialize(file_id: SKIP, position: SKIP, size_percent: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'SET_LOGO'
+      @file_id = file_id unless file_id == SKIP
+      @position = position unless position == SKIP
+      @size_percent = size_percent unless size_percent == 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.
+      file_id = hash.key?('fileId') ? hash['fileId'] : SKIP
+      position = hash.key?('position') ? hash['position'] : SKIP
+      size_percent = hash.key?('sizePercent') ? hash['sizePercent'] : 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.
+      RemixAction1.new(file_id: file_id,
+                       position: position,
+                       size_percent: size_percent,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction1 | 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}, file_id: #{@file_id}, position: #{@position}, size_percent:"\
+      " #{@size_percent}, 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}, file_id: #{@file_id.inspect}, position:"\
+      " #{@position.inspect}, size_percent: #{@size_percent.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end