vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/workflow_run.rb

@@ -0,0 +1,150 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # WorkflowRun Model.
+  class WorkflowRun < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque workflow run id.
+    # @return [String]
+    attr_accessor :workflow_run_id
+
+    # 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
+
+    # Workflow type identifier.
+    # @return [WorkflowType]
+    attr_accessor :workflow_type
+
+    # 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
+
+    # 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
+
+    # 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['workflow_run_id'] = 'workflowRunId'
+      @_hash['status'] = 'status'
+      @_hash['workflow_type'] = 'workflowType'
+      @_hash['progress_percentage'] = 'progressPercentage'
+      @_hash['attempt_index'] = 'attemptIndex'
+      @_hash['project_id'] = 'projectId'
+      @_hash['project_url'] = 'projectUrl'
+      @_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(workflow_run_id:, status:, workflow_type:,
+                   progress_percentage:, attempt_index:, project_id:,
+                   project_url:, error:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @workflow_run_id = workflow_run_id
+      @status = status
+      @workflow_type = workflow_type
+      @progress_percentage = progress_percentage
+      @attempt_index = attempt_index
+      @project_id = project_id
+      @project_url = project_url
+      @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.
+      workflow_run_id = hash.key?('workflowRunId') ? hash['workflowRunId'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      workflow_type = hash.key?('workflowType') ? hash['workflowType'] : nil
+      progress_percentage =
+        hash.key?('progressPercentage') ? hash['progressPercentage'] : nil
+      attempt_index = hash.key?('attemptIndex') ? hash['attemptIndex'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : nil
+      project_url = hash.key?('projectUrl') ? hash['projectUrl'] : 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.
+      WorkflowRun.new(workflow_run_id: workflow_run_id,
+                      status: status,
+                      workflow_type: workflow_type,
+                      progress_percentage: progress_percentage,
+                      attempt_index: attempt_index,
+                      project_id: project_id,
+                      project_url: project_url,
+                      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} workflow_run_id: #{@workflow_run_id}, status: #{@status}, workflow_type:"\
+      " #{@workflow_type}, progress_percentage: #{@progress_percentage}, attempt_index:"\
+      " #{@attempt_index}, project_id: #{@project_id}, project_url: #{@project_url}, 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} workflow_run_id: #{@workflow_run_id.inspect}, status: #{@status.inspect},"\
+      " workflow_type: #{@workflow_type.inspect}, progress_percentage:"\
+      " #{@progress_percentage.inspect}, attempt_index: #{@attempt_index.inspect}, project_id:"\
+      " #{@project_id.inspect}, project_url: #{@project_url.inspect}, error: #{@error.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/workflow_run_list_response.rb

@@ -0,0 +1,103 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Paginated list of API-started workflow runs, most recently created first.
+  class WorkflowRunListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[WorkflowRun]]
+    attr_accessor :workflow_runs
+
+    # When true, there are more runs available. Pass `nextCursor` as the
+    # `cursor` query param to fetch the next page.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # Opaque cursor to fetch the next page. `null` when `hasMore` is false.
+    # @return [String]
+    attr_accessor :next_cursor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['workflow_runs'] = 'workflowRuns'
+      @_hash['has_more'] = 'hasMore'
+      @_hash['next_cursor'] = 'nextCursor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        next_cursor
+      ]
+    end
+
+    def initialize(workflow_runs:, has_more:, next_cursor:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @workflow_runs = workflow_runs
+      @has_more = has_more
+      @next_cursor = next_cursor
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      workflow_runs = nil
+      unless hash['workflowRuns'].nil?
+        workflow_runs = []
+        hash['workflowRuns'].each do |structure|
+          workflow_runs << (WorkflowRun.from_hash(structure) if structure)
+        end
+      end
+
+      workflow_runs = nil unless hash.key?('workflowRuns')
+      has_more = hash.key?('hasMore') ? hash['hasMore'] : nil
+      next_cursor = hash.key?('nextCursor') ? hash['nextCursor'] : 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.
+      WorkflowRunListResponse.new(workflow_runs: workflow_runs,
+                                  has_more: has_more,
+                                  next_cursor: next_cursor,
+                                  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} workflow_runs: #{@workflow_runs}, has_more: #{@has_more}, next_cursor:"\
+      " #{@next_cursor}, 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_runs: #{@workflow_runs.inspect}, has_more: #{@has_more.inspect},"\
+      " next_cursor: #{@next_cursor.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/workflow_type.rb

@@ -0,0 +1,52 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Workflow type identifier.
+  class WorkflowType
+    WORKFLOW_TYPE = [
+      # TODO: Write general description for SCRIPT_TO_VIDEO
+      SCRIPT_TO_VIDEO = 'SCRIPT_TO_VIDEO'.freeze,
+
+      # TODO: Write general description for VOICEOVER_TO_VIDEO
+      VOICEOVER_TO_VIDEO = 'VOICEOVER_TO_VIDEO'.freeze,
+
+      # TODO: Write general description for SLIDESHOW_TO_VIDEO
+      SLIDESHOW_TO_VIDEO = 'SLIDESHOW_TO_VIDEO'.freeze,
+
+      # TODO: Write general description for STORYBOARD_TO_VIDEO
+      STORYBOARD_TO_VIDEO = 'STORYBOARD_TO_VIDEO'.freeze,
+
+      # TODO: Write general description for PROMPT_TO_VIDEO_CLIP
+      PROMPT_TO_VIDEO_CLIP = 'PROMPT_TO_VIDEO_CLIP'.freeze,
+
+      # TODO: Write general description for CREATIVE_BRIEF_TO_VIDEO
+      CREATIVE_BRIEF_TO_VIDEO = 'CREATIVE_BRIEF_TO_VIDEO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WORKFLOW_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SCRIPT_TO_VIDEO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'script_to_video' then SCRIPT_TO_VIDEO
+      when 'voiceover_to_video' then VOICEOVER_TO_VIDEO
+      when 'slideshow_to_video' then SLIDESHOW_TO_VIDEO
+      when 'storyboard_to_video' then STORYBOARD_TO_VIDEO
+      when 'prompt_to_video_clip' then PROMPT_TO_VIDEO_CLIP
+      when 'creative_brief_to_video' then CREATIVE_BRIEF_TO_VIDEO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/workflow_type1.rb

@@ -0,0 +1,52 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Identifier of the suggested workflow.
+  class WorkflowType1
+    WORKFLOW_TYPE1 = [
+      # TODO: Write general description for SCRIPT_TO_VIDEO
+      SCRIPT_TO_VIDEO = 'SCRIPT_TO_VIDEO'.freeze,
+
+      # TODO: Write general description for VOICEOVER_TO_VIDEO
+      VOICEOVER_TO_VIDEO = 'VOICEOVER_TO_VIDEO'.freeze,
+
+      # TODO: Write general description for SLIDESHOW_TO_VIDEO
+      SLIDESHOW_TO_VIDEO = 'SLIDESHOW_TO_VIDEO'.freeze,
+
+      # TODO: Write general description for STORYBOARD_TO_VIDEO
+      STORYBOARD_TO_VIDEO = 'STORYBOARD_TO_VIDEO'.freeze,
+
+      # TODO: Write general description for PROMPT_TO_VIDEO_CLIP
+      PROMPT_TO_VIDEO_CLIP = 'PROMPT_TO_VIDEO_CLIP'.freeze,
+
+      # TODO: Write general description for CREATIVE_BRIEF_TO_VIDEO
+      CREATIVE_BRIEF_TO_VIDEO = 'CREATIVE_BRIEF_TO_VIDEO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WORKFLOW_TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = SCRIPT_TO_VIDEO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'script_to_video' then SCRIPT_TO_VIDEO
+      when 'voiceover_to_video' then VOICEOVER_TO_VIDEO
+      when 'slideshow_to_video' then SLIDESHOW_TO_VIDEO
+      when 'storyboard_to_video' then STORYBOARD_TO_VIDEO
+      when 'prompt_to_video_clip' then PROMPT_TO_VIDEO_CLIP
+      when 'creative_brief_to_video' then CREATIVE_BRIEF_TO_VIDEO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/workflow_visual_style.rb

@@ -0,0 +1,136 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Visual style for the generated b-roll.
+  class WorkflowVisualStyle < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # STOCK pulls stock footage and images. AI_IMAGE generates a styled image
+    # for each section. Pass `entityId` to match a saved visual-style entity, or
+    # `aiStyle` for a free-form look.
+    # @return [WorkflowVisualStyleType]
+    attr_accessor :type
+
+    # Only applies when type is AI_IMAGE and `entityId` is omitted. A free-form
+    # description of the look applied to every generated image (e.g. `vintage
+    # 1970s film photography, warm grain`). See the AI styles reference for
+    # example descriptions of the app's default styles. Required when type is
+    # AI_IMAGE and `entityId` is omitted.
+    # @return [String]
+    attr_accessor :ai_style
+
+    # Only applies when type is AI_IMAGE. The id of a VISUAL_STYLE entity (e.g.
+    # `vg_enti_...`) whose reference images guide every generated image. When
+    # set, generated images match that entity instead of `aiStyle`.
+    # @return [String]
+    attr_accessor :entity_id
+
+    # Only applies when type is AI_IMAGE. When true, featured b-roll images you
+    # provide are re-rendered in the chosen style so they match the generated
+    # look (no effect on featured b-roll videos). Defaults to true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :restyle_featured_b_roll_with_ai_style
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['ai_style'] = 'aiStyle'
+      @_hash['entity_id'] = 'entityId'
+      @_hash['restyle_featured_b_roll_with_ai_style'] =
+        'restyleFeaturedBRollWithAiStyle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ai_style
+        entity_id
+        restyle_featured_b_roll_with_ai_style
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, ai_style: SKIP, entity_id: SKIP,
+                   restyle_featured_b_roll_with_ai_style: true,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @ai_style = ai_style unless ai_style == SKIP
+      @entity_id = entity_id unless entity_id == SKIP
+      unless restyle_featured_b_roll_with_ai_style == SKIP
+        @restyle_featured_b_roll_with_ai_style =
+          restyle_featured_b_roll_with_ai_style
+      end
+      @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.
+      type = hash.key?('type') ? hash['type'] : nil
+      ai_style = hash.key?('aiStyle') ? hash['aiStyle'] : SKIP
+      entity_id = hash.key?('entityId') ? hash['entityId'] : SKIP
+      restyle_featured_b_roll_with_ai_style =
+        hash['restyleFeaturedBRollWithAiStyle'] ||= true
+
+      # 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.
+      WorkflowVisualStyle.new(type: type,
+                              ai_style: ai_style,
+                              entity_id: entity_id,
+                              restyle_featured_b_roll_with_ai_style: restyle_featured_b_roll_with_ai_style,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [WorkflowVisualStyle | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { WorkflowVisualStyleType.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { WorkflowVisualStyleType.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, ai_style: #{@ai_style}, entity_id: #{@entity_id},"\
+      " restyle_featured_b_roll_with_ai_style: #{@restyle_featured_b_roll_with_ai_style},"\
+      " 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}, ai_style: #{@ai_style.inspect}, entity_id:"\
+      " #{@entity_id.inspect}, restyle_featured_b_roll_with_ai_style:"\
+      " #{@restyle_featured_b_roll_with_ai_style.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/workflow_visual_style_type.rb

@@ -0,0 +1,38 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # STOCK pulls stock footage and images. AI_IMAGE generates a styled image for
+  # each section. Pass `entityId` to match a saved visual-style entity, or
+  # `aiStyle` for a free-form look.
+  class WorkflowVisualStyleType
+    WORKFLOW_VISUAL_STYLE_TYPE = [
+      # TODO: Write general description for STOCK
+      STOCK = 'STOCK'.freeze,
+
+      # TODO: Write general description for AI_IMAGE
+      AI_IMAGE = 'AI_IMAGE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WORKFLOW_VISUAL_STYLE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = STOCK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'stock' then STOCK
+      when 'ai_image' then AI_IMAGE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Videogen
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/videogen/utilities/file_wrapper.rb

@@ -0,0 +1,28 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end