vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/start_assistant_chat_response.rb

@@ -0,0 +1,105 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Returned when a `POST /v1/assistants` call is accepted. Poll `messageId` for
+  # the pending assistant reply; keep `assistantId` / `projectId` to continue
+  # the chat and address the project.
+  class StartAssistantChatResponse < 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
+
+    # Opaque assistant chat id (e.g. `vg_asst_...`). Pass to `GET
+    # /v1/assistants/{assistantId}` and follow-up message/action calls.
+    # @return [String]
+    attr_accessor :assistant_id
+
+    # Opaque project id for the new chat (e.g. `vg_proj_...`).
+    # @return [String]
+    attr_accessor :project_id
+
+    # Deep link to open this project in the VideoGen web app.
+    # @return [String]
+    attr_accessor :project_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message_id'] = 'messageId'
+      @_hash['assistant_id'] = 'assistantId'
+      @_hash['project_id'] = 'projectId'
+      @_hash['project_url'] = 'projectUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message_id:, assistant_id:, project_id:, project_url:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @message_id = message_id
+      @assistant_id = assistant_id
+      @project_id = project_id
+      @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.
+      message_id = hash.key?('messageId') ? hash['messageId'] : nil
+      assistant_id = hash.key?('assistantId') ? hash['assistantId'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : 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.
+      StartAssistantChatResponse.new(message_id: message_id,
+                                     assistant_id: assistant_id,
+                                     project_id: project_id,
+                                     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} message_id: #{@message_id}, assistant_id: #{@assistant_id}, project_id:"\
+      " #{@project_id}, 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} message_id: #{@message_id.inspect}, assistant_id: #{@assistant_id.inspect},"\
+      " project_id: #{@project_id.inspect}, project_url: #{@project_url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/start_tool_execution_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 tool execution is started. Use `toolExecutionId` to poll for
+  # results or cancel.
+  class StartToolExecutionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Execution id (e.g. `vg_tool_...`).
+    # @return [String]
+    attr_accessor :tool_execution_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tool_execution_id'] = 'toolExecutionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tool_execution_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tool_execution_id = tool_execution_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.
+      tool_execution_id =
+        hash.key?('toolExecutionId') ? hash['toolExecutionId'] : 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.
+      StartToolExecutionResponse.new(tool_execution_id: tool_execution_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} tool_execution_id: #{@tool_execution_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} tool_execution_id: #{@tool_execution_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/start_workflow_run_response.rb

@@ -0,0 +1,141 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Returned when a workflow run is accepted. Poll `GET
+  # /v1/workflows/runs/{workflowRunId}` or subscribe to webhooks for completion.
+  class StartWorkflowRunResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque workflow run id (e.g. `vg_work_...`).
+    # @return [String]
+    attr_accessor :workflow_run_id
+
+    # Id of the project created for this workflow run (e.g. `vg_proj_...`).
+    # @return [String]
+    attr_accessor :project_id
+
+    # 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
+
+    # Opaque remix action ids (e.g. `vg_rmix_...`), one per `remixActions` entry
+    # in request order. Empty when no remix actions were requested. Each runs
+    # after the video is built; poll `GET
+    # /v1/projects/{projectId}/remix-actions`.
+    # @return [Array[String]]
+    attr_accessor :remix_action_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['workflow_run_id'] = 'workflowRunId'
+      @_hash['project_id'] = 'projectId'
+      @_hash['project_url'] = 'projectUrl'
+      @_hash['remix_action_ids'] = 'remixActionIds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(workflow_run_id:, project_id:, project_url:,
+                   remix_action_ids:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @workflow_run_id = workflow_run_id
+      @project_id = project_id
+      @project_url = project_url
+      @remix_action_ids = remix_action_ids
+      @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.
+      workflow_run_id = hash.key?('workflowRunId') ? hash['workflowRunId'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : nil
+      project_url = hash.key?('projectUrl') ? hash['projectUrl'] : nil
+      remix_action_ids =
+        hash.key?('remixActionIds') ? hash['remixActionIds'] : 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.
+      StartWorkflowRunResponse.new(workflow_run_id: workflow_run_id,
+                                   project_id: project_id,
+                                   project_url: project_url,
+                                   remix_action_ids: remix_action_ids,
+                                   additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [StartWorkflowRunResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.workflow_run_id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.project_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.project_url,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.remix_action_ids,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['workflowRunId'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['projectId'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['projectUrl'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['remixActionIds'],
+                                ->(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} workflow_run_id: #{@workflow_run_id}, project_id: #{@project_id},"\
+      " project_url: #{@project_url}, remix_action_ids: #{@remix_action_ids},"\
+      " 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} workflow_run_id: #{@workflow_run_id.inspect}, project_id:"\
+      " #{@project_id.inspect}, project_url: #{@project_url.inspect}, remix_action_ids:"\
+      " #{@remix_action_ids.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/text_to_speech_request.rb

@@ -0,0 +1,191 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # TextToSpeechRequest Model.
+  class TextToSpeechRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tts_text
+
+    # Catalog `displayName` (e.g. `Matilda`) or voice id from `GET
+    # /v1/resources/tts-voices` (e.g. `vg_voic_...`). Only voices with
+    # `supportsDirectToolExecution` set to true are accepted.
+    # @return [String]
+    attr_accessor :voice_id
+
+    # ISO-639-1 language hint for pronunciation (e.g. `en`, `es`, `zh`).
+    # @return [String]
+    attr_accessor :speech_language_code
+
+    # ISO-639-1 language hint for pronunciation (e.g. `en`, `es`, `zh`).
+    # @return [Array[PronunciationReplacement]]
+    attr_accessor :pronunciation_replacements
+
+    # When true, automatically expands numbers, symbols, acronyms, and other
+    # non-word tokens into their spoken forms before synthesis so the voice
+    # pronounces them correctly (e.g. `$100` → `one hundred dollars`, `NASA` →
+    # `nasa`, `3rd` → `third`). Defaults to false when omitted.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_expand_pronunciation_replacements
+
+    # 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
+
+    # 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['tts_text'] = 'ttsText'
+      @_hash['voice_id'] = 'voiceId'
+      @_hash['speech_language_code'] = 'speechLanguageCode'
+      @_hash['pronunciation_replacements'] = 'pronunciationReplacements'
+      @_hash['auto_expand_pronunciation_replacements'] =
+        'autoExpandPronunciationReplacements'
+      @_hash['voice_speed'] = 'voiceSpeed'
+      @_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[
+        speech_language_code
+        pronunciation_replacements
+        auto_expand_pronunciation_replacements
+        voice_speed
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        speech_language_code
+      ]
+    end
+
+    def initialize(tts_text:, voice_id:, speech_language_code: SKIP,
+                   pronunciation_replacements: SKIP,
+                   auto_expand_pronunciation_replacements: SKIP,
+                   voice_speed: 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?
+
+      @tts_text = tts_text
+      @voice_id = voice_id
+      @speech_language_code = speech_language_code unless speech_language_code == SKIP
+      unless pronunciation_replacements == SKIP
+        @pronunciation_replacements =
+          pronunciation_replacements
+      end
+      unless auto_expand_pronunciation_replacements == SKIP
+        @auto_expand_pronunciation_replacements =
+          auto_expand_pronunciation_replacements
+      end
+      @voice_speed = voice_speed unless voice_speed == 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.
+      tts_text = hash.key?('ttsText') ? hash['ttsText'] : nil
+      voice_id = hash.key?('voiceId') ? hash['voiceId'] : nil
+      speech_language_code =
+        hash.key?('speechLanguageCode') ? hash['speechLanguageCode'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      pronunciation_replacements = nil
+      unless hash['pronunciationReplacements'].nil?
+        pronunciation_replacements = []
+        hash['pronunciationReplacements'].each do |structure|
+          pronunciation_replacements << (PronunciationReplacement.from_hash(structure) if structure)
+        end
+      end
+
+      pronunciation_replacements = SKIP unless hash.key?('pronunciationReplacements')
+      auto_expand_pronunciation_replacements =
+        hash.key?('autoExpandPronunciationReplacements') ? hash['autoExpandPronunciationReplacements'] : SKIP
+      voice_speed = hash.key?('voiceSpeed') ? hash['voiceSpeed'] : 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.
+      TextToSpeechRequest.new(tts_text: tts_text,
+                              voice_id: voice_id,
+                              speech_language_code: speech_language_code,
+                              pronunciation_replacements: pronunciation_replacements,
+                              auto_expand_pronunciation_replacements: auto_expand_pronunciation_replacements,
+                              voice_speed: voice_speed,
+                              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} tts_text: #{@tts_text}, voice_id: #{@voice_id}, speech_language_code:"\
+      " #{@speech_language_code}, pronunciation_replacements: #{@pronunciation_replacements},"\
+      " auto_expand_pronunciation_replacements: #{@auto_expand_pronunciation_replacements},"\
+      " voice_speed: #{@voice_speed}, 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} tts_text: #{@tts_text.inspect}, voice_id: #{@voice_id.inspect},"\
+      " speech_language_code: #{@speech_language_code.inspect}, pronunciation_replacements:"\
+      " #{@pronunciation_replacements.inspect}, auto_expand_pronunciation_replacements:"\
+      " #{@auto_expand_pronunciation_replacements.inspect}, voice_speed: #{@voice_speed.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