vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/remix_action9.rb

@@ -0,0 +1,120 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Restyle every eligible still image in the project to a new look
+  # (image-to-image), replacing each image in place. Eligible images are non-SVG
+  # image assets backed by an uploaded or generated file. Runs asynchronously:
+  # one restyled image is generated per eligible image. If the project has no
+  # eligible images, the action is skipped and completes successfully without
+  # changing anything.
+  class RemixAction9 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: REGENERATE_IMAGES
+    # @return [String]
+    attr_reader :type
+
+    # Describe the visual style to apply to every image (e.g. "watercolor
+    # painting", "cinematic film still").
+    # @return [String]
+    attr_accessor :style_prompt
+
+    # Image generation quality tier for the restyled images. Optional; when
+    # omitted, your account's Default AI quality for images is used (change it
+    # at https://app.videogen.io/settings/account).
+    # @return [ModelQuality2]
+    attr_accessor :quality
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['style_prompt'] = 'stylePrompt'
+      @_hash['quality'] = 'quality'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        quality
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(style_prompt:, quality: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'REGENERATE_IMAGES'
+      @style_prompt = style_prompt
+      @quality = quality unless quality == 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.
+      style_prompt = hash.key?('stylePrompt') ? hash['stylePrompt'] : nil
+      quality = hash.key?('quality') ? hash['quality'] : 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.
+      RemixAction9.new(style_prompt: style_prompt,
+                       quality: quality,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixAction9 | 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 }) and
+            APIHelper.valid_type?(value.style_prompt,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['stylePrompt'],
+                                ->(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}, style_prompt: #{@style_prompt}, quality: #{@quality},"\
+      " 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}, style_prompt: #{@style_prompt.inspect}, quality:"\
+      " #{@quality.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action_discriminator_mapping_set_logo_position.rb

@@ -0,0 +1,53 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Position the logo is anchored to. Omit or pass `null` to keep the current
+  # position.
+  class RemixActionDiscriminatorMappingSetLogoPosition
+    REMIX_ACTION_DISCRIMINATOR_MAPPING_SET_LOGO_POSITION = [
+      # TODO: Write general description for TOP_LEFT
+      TOP_LEFT = 'TOP_LEFT'.freeze,
+
+      # TODO: Write general description for TOP_CENTER
+      TOP_CENTER = 'TOP_CENTER'.freeze,
+
+      # TODO: Write general description for TOP_RIGHT
+      TOP_RIGHT = 'TOP_RIGHT'.freeze,
+
+      # TODO: Write general description for BOTTOM_LEFT
+      BOTTOM_LEFT = 'BOTTOM_LEFT'.freeze,
+
+      # TODO: Write general description for BOTTOM_CENTER
+      BOTTOM_CENTER = 'BOTTOM_CENTER'.freeze,
+
+      # TODO: Write general description for BOTTOM_RIGHT
+      BOTTOM_RIGHT = 'BOTTOM_RIGHT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REMIX_ACTION_DISCRIMINATOR_MAPPING_SET_LOGO_POSITION.include?(value)
+    end
+
+    def self.from_value(value, default_value = TOP_LEFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'top_left' then TOP_LEFT
+      when 'top_center' then TOP_CENTER
+      when 'top_right' then TOP_RIGHT
+      when 'bottom_left' then BOTTOM_LEFT
+      when 'bottom_center' then BOTTOM_CENTER
+      when 'bottom_right' then BOTTOM_RIGHT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/remix_action_run.rb

@@ -0,0 +1,150 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # RemixActionRun Model.
+  class RemixActionRun < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque remix action id (e.g. `vg_rmix_...`).
+    # @return [String]
+    attr_accessor :remix_action_id
+
+    # The kind of edit a remix action applies.
+    # @return [RemixActionType]
+    attr_accessor :type
+
+    # Lifecycle status shared by every asynchronous job (tool executions,
+    # workflow runs, remix actions, project exports, and timeline interchange
+    # jobs). `pending` and `running` are in-progress; `succeeded`, `failed`, and
+    # `cancelled` are terminal.
+    # @return [JobStatus]
+    attr_accessor :status
+
+    # Id of the project this remix action edits (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
+
+    # Completion progress for the current attempt (0-100). Always `100` when
+    # `status` is `succeeded`.
+    # @return [Float]
+    attr_accessor :progress_percentage
+
+    # Zero-based index of the current or most recent execution attempt.
+    # @return [Integer]
+    attr_accessor :attempt_index
+
+    # Error details. Always present as a field; `null` unless `status` is
+    # `failed`.
+    # @return [ApiError]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['remix_action_id'] = 'remixActionId'
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['project_id'] = 'projectId'
+      @_hash['project_url'] = 'projectUrl'
+      @_hash['progress_percentage'] = 'progressPercentage'
+      @_hash['attempt_index'] = 'attemptIndex'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        error
+      ]
+    end
+
+    def initialize(remix_action_id:, type:, status:, project_id:, project_url:,
+                   progress_percentage:, attempt_index:, error:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @remix_action_id = remix_action_id
+      @type = type
+      @status = status
+      @project_id = project_id
+      @project_url = project_url
+      @progress_percentage = progress_percentage
+      @attempt_index = attempt_index
+      @error = error
+      @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.
+      remix_action_id = hash.key?('remixActionId') ? hash['remixActionId'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : nil
+      project_url = hash.key?('projectUrl') ? hash['projectUrl'] : nil
+      progress_percentage =
+        hash.key?('progressPercentage') ? hash['progressPercentage'] : nil
+      attempt_index = hash.key?('attemptIndex') ? hash['attemptIndex'] : nil
+      error = ApiError.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      RemixActionRun.new(remix_action_id: remix_action_id,
+                         type: type,
+                         status: status,
+                         project_id: project_id,
+                         project_url: project_url,
+                         progress_percentage: progress_percentage,
+                         attempt_index: attempt_index,
+                         error: error,
+                         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} remix_action_id: #{@remix_action_id}, type: #{@type}, status: #{@status},"\
+      " project_id: #{@project_id}, project_url: #{@project_url}, progress_percentage:"\
+      " #{@progress_percentage}, attempt_index: #{@attempt_index}, error: #{@error},"\
+      " 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} remix_action_id: #{@remix_action_id.inspect}, type: #{@type.inspect},"\
+      " status: #{@status.inspect}, project_id: #{@project_id.inspect}, project_url:"\
+      " #{@project_url.inspect}, progress_percentage: #{@progress_percentage.inspect},"\
+      " attempt_index: #{@attempt_index.inspect}, error: #{@error.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_action_type.rb

@@ -0,0 +1,88 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # The kind of edit a remix action applies.
+  class RemixActionType
+    REMIX_ACTION_TYPE = [
+      # TODO: Write general description for SET_BACKGROUND_MUSIC
+      SET_BACKGROUND_MUSIC = 'SET_BACKGROUND_MUSIC'.freeze,
+
+      # TODO: Write general description for SET_LOGO
+      SET_LOGO = 'SET_LOGO'.freeze,
+
+      # TODO: Write general description for ENABLE_CAPTIONS
+      ENABLE_CAPTIONS = 'ENABLE_CAPTIONS'.freeze,
+
+      # TODO: Write general description for DISABLE_CAPTIONS
+      DISABLE_CAPTIONS = 'DISABLE_CAPTIONS'.freeze,
+
+      # TODO: Write general description for ADD_TRANSITIONS
+      ADD_TRANSITIONS = 'ADD_TRANSITIONS'.freeze,
+
+      # TODO: Write general description for ADD_ZOOM
+      ADD_ZOOM = 'ADD_ZOOM'.freeze,
+
+      # TODO: Write general description for RESIZE_PROJECT
+      RESIZE_PROJECT = 'RESIZE_PROJECT'.freeze,
+
+      # TODO: Write general description for CLEAN_UP_TRANSCRIPT
+      CLEAN_UP_TRANSCRIPT = 'CLEAN_UP_TRANSCRIPT'.freeze,
+
+      # TODO: Write general description for CONVERT_IMAGES_TO_VIDEOS
+      CONVERT_IMAGES_TO_VIDEOS = 'CONVERT_IMAGES_TO_VIDEOS'.freeze,
+
+      # TODO: Write general description for REGENERATE_IMAGES
+      REGENERATE_IMAGES = 'REGENERATE_IMAGES'.freeze,
+
+      # TODO: Write general description for UPSCALE_ASSETS
+      UPSCALE_ASSETS = 'UPSCALE_ASSETS'.freeze,
+
+      # TODO: Write general description for CHANGE_NARRATOR
+      CHANGE_NARRATOR = 'CHANGE_NARRATOR'.freeze,
+
+      # TODO: Write general description for SHUFFLE_STOCK_VISUALS
+      SHUFFLE_STOCK_VISUALS = 'SHUFFLE_STOCK_VISUALS'.freeze,
+
+      # TODO: Write general description for GENERATE_MUSIC
+      GENERATE_MUSIC = 'GENERATE_MUSIC'.freeze,
+
+      # TODO: Write general description for TRANSLATE_PROJECT
+      TRANSLATE_PROJECT = 'TRANSLATE_PROJECT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REMIX_ACTION_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SET_BACKGROUND_MUSIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'set_background_music' then SET_BACKGROUND_MUSIC
+      when 'set_logo' then SET_LOGO
+      when 'enable_captions' then ENABLE_CAPTIONS
+      when 'disable_captions' then DISABLE_CAPTIONS
+      when 'add_transitions' then ADD_TRANSITIONS
+      when 'add_zoom' then ADD_ZOOM
+      when 'resize_project' then RESIZE_PROJECT
+      when 'clean_up_transcript' then CLEAN_UP_TRANSCRIPT
+      when 'convert_images_to_videos' then CONVERT_IMAGES_TO_VIDEOS
+      when 'regenerate_images' then REGENERATE_IMAGES
+      when 'upscale_assets' then UPSCALE_ASSETS
+      when 'change_narrator' then CHANGE_NARRATOR
+      when 'shuffle_stock_visuals' then SHUFFLE_STOCK_VISUALS
+      when 'generate_music' then GENERATE_MUSIC
+      when 'translate_project' then TRANSLATE_PROJECT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/remix_project_request.rb

@@ -0,0 +1,105 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # RemixProjectRequest Model.
+  class RemixProjectRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Ordered list of edits to apply. Each runs asynchronously as its own remix
+    # action. Must contain at least one action.
+    # @return [Array[Object]]
+    attr_accessor :remix_actions
+
+    # When true, the project is duplicated first and the edits are applied to
+    # the copy, leaving the original untouched. The response's `projectId` is
+    # the copy. Defaults to false (edits the project in place).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :save_as_new_project
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['remix_actions'] = 'remixActions'
+      @_hash['save_as_new_project'] = 'saveAsNewProject'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        save_as_new_project
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(remix_actions:, save_as_new_project: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @remix_actions = remix_actions
+      @save_as_new_project = save_as_new_project unless save_as_new_project == 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.
+      remix_actions = hash.key?('remixActions') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RemixAction152), hash['remixActions']
+      ) : nil
+      save_as_new_project =
+        hash.key?('saveAsNewProject') ? hash['saveAsNewProject'] : 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.
+      RemixProjectRequest.new(remix_actions: remix_actions,
+                              save_as_new_project: save_as_new_project,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemixProjectRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:RemixAction152)
+                              .validate(value.remix_actions)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:RemixAction152)
+                     .validate(value['remixActions'])
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} remix_actions: #{@remix_actions}, save_as_new_project:"\
+      " #{@save_as_new_project}, 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} remix_actions: #{@remix_actions.inspect}, save_as_new_project:"\
+      " #{@save_as_new_project.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/remix_project_response.rb

@@ -0,0 +1,101 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Returned when remix actions are accepted. Poll `GET
+  # /v1/projects/{projectId}/remix-actions` for status.
+  class RemixProjectResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Id of the edited project (e.g. `vg_proj_...`; the duplicate when
+    # `saveAsNewProject` was true).
+    # @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 requested action in
+    # order.
+    # @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['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(project_id:, project_url:, remix_action_ids:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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.
+      RemixProjectResponse.new(project_id: project_id,
+                               project_url: project_url,
+                               remix_action_ids: remix_action_ids,
+                               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}, 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} 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/remix_transition_style.rb

@@ -0,0 +1,58 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A transition applied at a boundary. `DYNAMIC` auto-varies the style across
+  # boundaries; `NONE` removes transitions; the rest apply that fixed style
+  # everywhere.
+  class RemixTransitionStyle
+    REMIX_TRANSITION_STYLE = [
+      # TODO: Write general description for DYNAMIC
+      DYNAMIC = 'DYNAMIC'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze,
+
+      # TODO: Write general description for FADE
+      FADE = 'FADE'.freeze,
+
+      # TODO: Write general description for RISE
+      RISE = 'RISE'.freeze,
+
+      # TODO: Write general description for PAN
+      PAN = 'PAN'.freeze,
+
+      # TODO: Write general description for POP
+      POP = 'POP'.freeze,
+
+      # TODO: Write general description for WIPE
+      WIPE = 'WIPE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REMIX_TRANSITION_STYLE.include?(value)
+    end
+
+    def self.from_value(value, default_value = DYNAMIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'dynamic' then DYNAMIC
+      when 'none' then NONE
+      when 'fade' then FADE
+      when 'rise' then RISE
+      when 'pan' then PAN
+      when 'pop' then POP
+      when 'wipe' then WIPE
+      else
+        default_value
+      end
+    end
+  end
+end