vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/search_files_result.rb

@@ -0,0 +1,85 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # SearchFilesResult Model.
+  class SearchFilesResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Cosine similarity between the query embedding and the file description
+    # embedding. Ranges from 0 (no match) to 1 (identical). Values above 0.7
+    # typically indicate strong relevance.
+    # @return [Float]
+    attr_accessor :similarity
+
+    # Metadata for a generated file. Obtain ids from tool results or `GET
+    # /v1/files`.
+    # @return [FileInfo]
+    attr_accessor :file
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['similarity'] = 'similarity'
+      @_hash['file'] = 'file'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(similarity:, file:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @similarity = similarity
+      @file = file
+      @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.
+      similarity = hash.key?('similarity') ? hash['similarity'] : nil
+      file = FileInfo.from_hash(hash['file']) if hash['file']
+
+      # 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.
+      SearchFilesResult.new(similarity: similarity,
+                            file: file,
+                            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} similarity: #{@similarity}, file: #{@file}, 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} similarity: #{@similarity.inspect}, file: #{@file.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/send_assistant_message_request.rb

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

data/lib/videogen/models/send_assistant_message_response.rb

@@ -0,0 +1,76 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Returned when a `POST /v1/assistants/{assistantId}/messages` call is
+  # accepted. Use `messageId` to poll the pending assistant reply.
+  class SendAssistantMessageResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque assistant message id for the pending assistant reply (e.g.
+    # `vg_mesg_...`). Poll `GET /v1/assistant-messages/{messageId}`.
+    # @return [String]
+    attr_accessor :message_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message_id'] = 'messageId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @message_id = message_id
+      @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.
+      message_id = hash.key?('messageId') ? hash['messageId'] : 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.
+      SendAssistantMessageResponse.new(message_id: message_id,
+                                       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} message_id: #{@message_id}, 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} message_id: #{@message_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/slideshow_to_video_request.rb

@@ -0,0 +1,276 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # SlideshowToVideoRequest Model.
+  class SlideshowToVideoRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque file id of an uploaded PDF or PowerPoint file (e.g. `vg_file_...`).
+    # Upload the file first via `POST /v1/files/upload`.
+    # @return [String]
+    attr_accessor :file_id
+
+    # Optional per-slide narration, in slide order, applied by index: each slide
+    # uses its matching entry, and an empty string makes that slide silent. If
+    # you provide fewer entries than slides, the remaining slides are silent;
+    # extra entries are ignored. Omit this field entirely to narrate each slide
+    # from its speaker notes in the uploaded file. To guarantee no narration on
+    # any slide, pass an empty array.
+    # @return [Array[String]]
+    attr_accessor :slide_scripts
+
+    # Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel
+    # dimensions.
+    # @return [AspectRatio]
+    attr_accessor :aspect_ratio
+
+    # Output language as a BCP-47 code (e.g. `en`, `es`, `fr`). Defaults to
+    # English.
+    # @return [String]
+    attr_accessor :language
+
+    # Catalog `displayName` (e.g. `Matilda`) or voice id from `GET
+    # /v1/resources/tts-voices` (e.g. `vg_voic_...`). A default voice is used
+    # when omitted. Any voice may be used here, including voices where
+    # `supportsDirectToolExecution` is false.
+    # @return [String]
+    attr_accessor :voice_id
+
+    # Speech rate multiplier, between 0.5 (half speed) and 2 (double speed).
+    # Defaults to the voice's default speed.
+    # @return [Float]
+    attr_accessor :voice_speed
+
+    # Recommended. Optional id of a built-in stock actor or an ACTOR entity
+    # (e.g. `vg_enti_...`) with an image reference. When set, narration is
+    # delivered by that actor avatar. Omit or pass `null` for voiceover without
+    # an avatar.
+    # @return [String]
+    attr_accessor :actor_entity_id
+
+    # Avatar generation quality tier. Applies when `actorEntityId` is provided.
+    # Optional; when omitted, your account's Default AI quality for avatars is
+    # used.
+    # @return [ModelQuality3]
+    attr_accessor :avatar_quality
+
+    # Optional id of a SLIDESHOW_THEME entity (e.g. `vg_enti_...`) whose
+    # reference board defines the shared slide design system (fonts, colors,
+    # layout) applied to generated or edited slides. Create one via `POST
+    # /v1/entities` with `entityType` SLIDESHOW_THEME and attach a reference
+    # image or a PDF / PowerPoint. Omit when converting an uploaded deck's
+    # original pages into a video; VideoGen derives a theme from those pages in
+    # the background so later edits can match the original slides.
+    # @return [String]
+    attr_accessor :slideshow_theme_entity_id
+
+    # Caption styling. Omit to use the default style with captions shown. Pass
+    # an object to override individual style fields (any omitted field uses the
+    # default). Pass `null` to hide captions entirely.
+    # @return [WorkflowCaptionStyle]
+    attr_accessor :caption_style
+
+    # Optional file id of an uploaded logo image to overlay on the video (e.g.
+    # `vg_file_...`). Upload the image first via `POST /v1/files/upload`. Only
+    # image files are accepted.
+    # @return [String]
+    attr_accessor :logo_file_id
+
+    # Optional edits applied to the project after the video is built, in order.
+    # Each action runs asynchronously; the response returns one remix action id
+    # per action. Captions and a logo are set with the `captionStyle` and
+    # `logoFileId` request fields above; recommended remix actions here are
+    # `CONVERT_IMAGES_TO_VIDEOS` to animate still images into clips, and
+    # `ADD_TRANSITIONS` to stamp transitions between sections and assets. See
+    # the [Remix actions](/remix-actions) guide.
+    # @return [Array[Object]]
+    attr_accessor :remix_actions
+
+    # When true, the video's generated OUTPUT files (AI images, video clips,
+    # voiceover audio, avatars) are created as temporary: guaranteed available
+    # for 24 hours, after which they may be archived and later deleted. This
+    # also covers files produced by post-build remix actions (e.g. generated
+    # background music, image-to-video conversions). 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['file_id'] = 'fileId'
+      @_hash['slide_scripts'] = 'slideScripts'
+      @_hash['aspect_ratio'] = 'aspectRatio'
+      @_hash['language'] = 'language'
+      @_hash['voice_id'] = 'voiceId'
+      @_hash['voice_speed'] = 'voiceSpeed'
+      @_hash['actor_entity_id'] = 'actorEntityId'
+      @_hash['avatar_quality'] = 'avatarQuality'
+      @_hash['slideshow_theme_entity_id'] = 'slideshowThemeEntityId'
+      @_hash['caption_style'] = 'captionStyle'
+      @_hash['logo_file_id'] = 'logoFileId'
+      @_hash['remix_actions'] = 'remixActions'
+      @_hash['is_output_temporary'] = 'isOutputTemporary'
+      @_hash['hide_from_ui'] = 'hideFromUi'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        slide_scripts
+        aspect_ratio
+        language
+        voice_id
+        voice_speed
+        actor_entity_id
+        avatar_quality
+        slideshow_theme_entity_id
+        caption_style
+        logo_file_id
+        remix_actions
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        voice_id
+        actor_entity_id
+        caption_style
+        logo_file_id
+      ]
+    end
+
+    def initialize(file_id:, slide_scripts: SKIP, aspect_ratio: SKIP,
+                   language: SKIP, voice_id: SKIP, voice_speed: SKIP,
+                   actor_entity_id: SKIP, avatar_quality: SKIP,
+                   slideshow_theme_entity_id: SKIP, caption_style: SKIP,
+                   logo_file_id: SKIP, remix_actions: 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?
+
+      @file_id = file_id
+      @slide_scripts = slide_scripts unless slide_scripts == SKIP
+      @aspect_ratio = aspect_ratio unless aspect_ratio == SKIP
+      @language = language unless language == SKIP
+      @voice_id = voice_id unless voice_id == SKIP
+      @voice_speed = voice_speed unless voice_speed == SKIP
+      @actor_entity_id = actor_entity_id unless actor_entity_id == SKIP
+      @avatar_quality = avatar_quality unless avatar_quality == SKIP
+      unless slideshow_theme_entity_id == SKIP
+        @slideshow_theme_entity_id =
+          slideshow_theme_entity_id
+      end
+      @caption_style = caption_style unless caption_style == SKIP
+      @logo_file_id = logo_file_id unless logo_file_id == SKIP
+      @remix_actions = remix_actions unless remix_actions == 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.
+      file_id = hash.key?('fileId') ? hash['fileId'] : nil
+      slide_scripts = hash.key?('slideScripts') ? hash['slideScripts'] : SKIP
+      aspect_ratio = AspectRatio.from_hash(hash['aspectRatio']) if hash['aspectRatio']
+      language = hash.key?('language') ? hash['language'] : SKIP
+      voice_id = hash.key?('voiceId') ? hash['voiceId'] : SKIP
+      voice_speed = hash.key?('voiceSpeed') ? hash['voiceSpeed'] : SKIP
+      actor_entity_id =
+        hash.key?('actorEntityId') ? hash['actorEntityId'] : SKIP
+      avatar_quality = hash.key?('avatarQuality') ? hash['avatarQuality'] : SKIP
+      slideshow_theme_entity_id =
+        hash.key?('slideshowThemeEntityId') ? hash['slideshowThemeEntityId'] : SKIP
+      caption_style = WorkflowCaptionStyle.from_hash(hash['captionStyle']) if hash['captionStyle']
+      logo_file_id = hash.key?('logoFileId') ? hash['logoFileId'] : SKIP
+      remix_actions = hash.key?('remixActions') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RemixAction15), hash['remixActions']
+      ) : 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.
+      SlideshowToVideoRequest.new(file_id: file_id,
+                                  slide_scripts: slide_scripts,
+                                  aspect_ratio: aspect_ratio,
+                                  language: language,
+                                  voice_id: voice_id,
+                                  voice_speed: voice_speed,
+                                  actor_entity_id: actor_entity_id,
+                                  avatar_quality: avatar_quality,
+                                  slideshow_theme_entity_id: slideshow_theme_entity_id,
+                                  caption_style: caption_style,
+                                  logo_file_id: logo_file_id,
+                                  remix_actions: remix_actions,
+                                  is_output_temporary: is_output_temporary,
+                                  hide_from_ui: hide_from_ui,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SlideshowToVideoRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.file_id,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['fileId'],
+                            ->(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} file_id: #{@file_id}, slide_scripts: #{@slide_scripts}, aspect_ratio:"\
+      " #{@aspect_ratio}, language: #{@language}, voice_id: #{@voice_id}, voice_speed:"\
+      " #{@voice_speed}, actor_entity_id: #{@actor_entity_id}, avatar_quality: #{@avatar_quality},"\
+      " slideshow_theme_entity_id: #{@slideshow_theme_entity_id}, caption_style:"\
+      " #{@caption_style}, logo_file_id: #{@logo_file_id}, remix_actions: #{@remix_actions},"\
+      " 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} file_id: #{@file_id.inspect}, slide_scripts: #{@slide_scripts.inspect},"\
+      " aspect_ratio: #{@aspect_ratio.inspect}, language: #{@language.inspect}, voice_id:"\
+      " #{@voice_id.inspect}, voice_speed: #{@voice_speed.inspect}, actor_entity_id:"\
+      " #{@actor_entity_id.inspect}, avatar_quality: #{@avatar_quality.inspect},"\
+      " slideshow_theme_entity_id: #{@slideshow_theme_entity_id.inspect}, caption_style:"\
+      " #{@caption_style.inspect}, logo_file_id: #{@logo_file_id.inspect}, remix_actions:"\
+      " #{@remix_actions.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/start_assistant_chat_request.rb

@@ -0,0 +1,88 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # StartAssistantChatRequest Model.
+  class StartAssistantChatRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first message to send to the assistant, exactly as a person would type
+    # it into the assistant on a new project.
+    # @return [String]
+    attr_accessor :message
+
+    # When true, the assistant picks the best workflow for the message and
+    # immediately starts generating, skipping the suggestion step. When the
+    # assistant message reaches `succeeded`, its `generation` carries the
+    # workflow run to poll.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_generate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['auto_generate'] = 'autoGenerate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auto_generate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message:, auto_generate: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @message = message
+      @auto_generate = auto_generate unless auto_generate == 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.
+      message = hash.key?('message') ? hash['message'] : nil
+      auto_generate = hash['autoGenerate'] ||= 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.
+      StartAssistantChatRequest.new(message: message,
+                                    auto_generate: auto_generate,
+                                    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} message: #{@message}, auto_generate: #{@auto_generate},"\
+      " 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} message: #{@message.inspect}, auto_generate: #{@auto_generate.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end