vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/timeline_interchange.rb

@@ -0,0 +1,210 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # TimelineInterchange Model.
+  class TimelineInterchange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque timeline interchange job id (e.g. `vg_inte_...`) matching the
+    # original request.
+    # @return [String]
+    attr_accessor :interchange_job_id
+
+    # Id of the source project (e.g. `vg_proj_...`).
+    # @return [String]
+    attr_accessor :project_id
+
+    # Editor interchange document format. `FCPXML` is Final Cut Pro (also
+    # imported by DaVinci Resolve and others). `PREMIERE_XML` is the Final Cut 7
+    # `xmeml` XML that Adobe Premiere Pro imports natively. `OTIO` is
+    # OpenTimelineIO, the vendor-neutral format. `SRT` is a SubRip caption
+    # sidecar.
+    # @return [TimelineInterchangeFormat]
+    attr_accessor :format
+
+    # How the interchange document references media. `REMOTE_URLS` produces a
+    # single document that links to signed media URLs. `BUNDLE` produces a zip
+    # containing the document plus every referenced media file, referenced by
+    # relative path, for durable offline relinking.
+    # @return [TimelineInterchangeMediaDelivery]
+    attr_accessor :media_delivery
+
+    # 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
+
+    # 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 job attempt.
+    # @return [Integer]
+    attr_accessor :attempt_index
+
+    # Private signed download URL for the interchange document (or the media
+    # bundle zip when `mediaDelivery` is `BUNDLE`), valid for 7 days from when
+    # it was signed. Always present as a field; `null` until `status` is
+    # `succeeded`. This endpoint automatically re-signs the URL when it is
+    # within an hour of expiring. To fetch a fresh URL directly from the
+    # underlying file at any time, use `interchangeFileId` with the hydrate-file
+    # endpoint.
+    # @return [String]
+    attr_accessor :download_url
+
+    # Seconds since epoch (Unix timestamp) when `downloadUrl` expires. `null`
+    # while `downloadUrl` is null.
+    # @return [Integer]
+    attr_accessor :download_url_expires_at
+
+    # File id (e.g. `vg_file_...`) of the interchange document or bundle zip.
+    # Always present as a field; `null` until `status` is `succeeded`. Pass it
+    # to `POST /v1/files/{fileId}/hydrate` to fetch fresh signed URLs directly
+    # from the file at any time.
+    # @return [String]
+    attr_accessor :interchange_file_id
+
+    # Hydrated interchange file metadata with a signed download URL. Always
+    # present as a field; `null` until `status` is `succeeded`. Its signed URL
+    # follows the same 24-hour validity and automatic re-signing as
+    # `downloadUrl`.
+    # @return [FileInfo]
+    attr_accessor :file
+
+    # 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['interchange_job_id'] = 'interchangeJobId'
+      @_hash['project_id'] = 'projectId'
+      @_hash['format'] = 'format'
+      @_hash['media_delivery'] = 'mediaDelivery'
+      @_hash['status'] = 'status'
+      @_hash['progress_percentage'] = 'progressPercentage'
+      @_hash['attempt_index'] = 'attemptIndex'
+      @_hash['download_url'] = 'downloadUrl'
+      @_hash['download_url_expires_at'] = 'downloadUrlExpiresAt'
+      @_hash['interchange_file_id'] = 'interchangeFileId'
+      @_hash['file'] = 'file'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        download_url
+        download_url_expires_at
+        interchange_file_id
+        file
+        error
+      ]
+    end
+
+    def initialize(interchange_job_id:, project_id:, format:, media_delivery:,
+                   status:, progress_percentage:, attempt_index:, download_url:,
+                   download_url_expires_at:, interchange_file_id:, file:,
+                   error:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @interchange_job_id = interchange_job_id
+      @project_id = project_id
+      @format = format
+      @media_delivery = media_delivery
+      @status = status
+      @progress_percentage = progress_percentage
+      @attempt_index = attempt_index
+      @download_url = download_url
+      @download_url_expires_at = download_url_expires_at
+      @interchange_file_id = interchange_file_id
+      @file = file
+      @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.
+      interchange_job_id =
+        hash.key?('interchangeJobId') ? hash['interchangeJobId'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : nil
+      format = hash.key?('format') ? hash['format'] : nil
+      media_delivery = hash.key?('mediaDelivery') ? hash['mediaDelivery'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      progress_percentage =
+        hash.key?('progressPercentage') ? hash['progressPercentage'] : nil
+      attempt_index = hash.key?('attemptIndex') ? hash['attemptIndex'] : nil
+      download_url = hash.key?('downloadUrl') ? hash['downloadUrl'] : nil
+      download_url_expires_at =
+        hash.key?('downloadUrlExpiresAt') ? hash['downloadUrlExpiresAt'] : nil
+      interchange_file_id =
+        hash.key?('interchangeFileId') ? hash['interchangeFileId'] : nil
+      file = FileInfo.from_hash(hash['file']) if hash['file']
+      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.
+      TimelineInterchange.new(interchange_job_id: interchange_job_id,
+                              project_id: project_id,
+                              format: format,
+                              media_delivery: media_delivery,
+                              status: status,
+                              progress_percentage: progress_percentage,
+                              attempt_index: attempt_index,
+                              download_url: download_url,
+                              download_url_expires_at: download_url_expires_at,
+                              interchange_file_id: interchange_file_id,
+                              file: file,
+                              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} interchange_job_id: #{@interchange_job_id}, project_id: #{@project_id},"\
+      " format: #{@format}, media_delivery: #{@media_delivery}, status: #{@status},"\
+      " progress_percentage: #{@progress_percentage}, attempt_index: #{@attempt_index},"\
+      " download_url: #{@download_url}, download_url_expires_at: #{@download_url_expires_at},"\
+      " interchange_file_id: #{@interchange_file_id}, file: #{@file}, 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} interchange_job_id: #{@interchange_job_id.inspect}, project_id:"\
+      " #{@project_id.inspect}, format: #{@format.inspect}, media_delivery:"\
+      " #{@media_delivery.inspect}, status: #{@status.inspect}, progress_percentage:"\
+      " #{@progress_percentage.inspect}, attempt_index: #{@attempt_index.inspect}, download_url:"\
+      " #{@download_url.inspect}, download_url_expires_at: #{@download_url_expires_at.inspect},"\
+      " interchange_file_id: #{@interchange_file_id.inspect}, file: #{@file.inspect}, error:"\
+      " #{@error.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/timeline_interchange_format.rb

@@ -0,0 +1,47 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Editor interchange document format. `FCPXML` is Final Cut Pro (also imported
+  # by DaVinci Resolve and others). `PREMIERE_XML` is the Final Cut 7 `xmeml`
+  # XML that Adobe Premiere Pro imports natively. `OTIO` is OpenTimelineIO, the
+  # vendor-neutral format. `SRT` is a SubRip caption sidecar.
+  class TimelineInterchangeFormat
+    TIMELINE_INTERCHANGE_FORMAT = [
+      # TODO: Write general description for FCPXML
+      FCPXML = 'FCPXML'.freeze,
+
+      # TODO: Write general description for PREMIERE_XML
+      PREMIERE_XML = 'PREMIERE_XML'.freeze,
+
+      # TODO: Write general description for OTIO
+      OTIO = 'OTIO'.freeze,
+
+      # TODO: Write general description for SRT
+      SRT = 'SRT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TIMELINE_INTERCHANGE_FORMAT.include?(value)
+    end
+
+    def self.from_value(value, default_value = FCPXML)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fcpxml' then FCPXML
+      when 'premiere_xml' then PREMIERE_XML
+      when 'otio' then OTIO
+      when 'srt' then SRT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/timeline_interchange_media_delivery.rb

@@ -0,0 +1,39 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # How the interchange document references media. `REMOTE_URLS` produces a
+  # single document that links to signed media URLs. `BUNDLE` produces a zip
+  # containing the document plus every referenced media file, referenced by
+  # relative path, for durable offline relinking.
+  class TimelineInterchangeMediaDelivery
+    TIMELINE_INTERCHANGE_MEDIA_DELIVERY = [
+      # TODO: Write general description for REMOTE_URLS
+      REMOTE_URLS = 'REMOTE_URLS'.freeze,
+
+      # TODO: Write general description for BUNDLE
+      BUNDLE = 'BUNDLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TIMELINE_INTERCHANGE_MEDIA_DELIVERY.include?(value)
+    end
+
+    def self.from_value(value, default_value = REMOTE_URLS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'remote_urls' then REMOTE_URLS
+      when 'bundle' then BUNDLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/tool_execution_list_response.rb

@@ -0,0 +1,104 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Paginated list of API-started tool executions, most recently created first.
+  class ToolExecutionListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ExecutedTool]]
+    attr_accessor :tool_executions
+
+    # When true, there are more executions 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['tool_executions'] = 'toolExecutions'
+      @_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(tool_executions:, has_more:, next_cursor:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tool_executions = tool_executions
+      @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
+      tool_executions = nil
+      unless hash['toolExecutions'].nil?
+        tool_executions = []
+        hash['toolExecutions'].each do |structure|
+          tool_executions << (ExecutedTool.from_hash(structure) if structure)
+        end
+      end
+
+      tool_executions = nil unless hash.key?('toolExecutions')
+      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.
+      ToolExecutionListResponse.new(tool_executions: tool_executions,
+                                    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} tool_executions: #{@tool_executions}, 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} tool_executions: #{@tool_executions.inspect}, has_more:"\
+      " #{@has_more.inspect}, next_cursor: #{@next_cursor.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/tool_success_result.rb

@@ -0,0 +1,152 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Result for a single generated file. Only appears inside a succeeded
+  # execution's `results`, so every field below is always present.
+  class ToolSuccessResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # File id for the generated asset.
+    # @return [String]
+    attr_accessor :file_id
+
+    # File type.
+    # @return [FileType1]
+    attr_accessor :type
+
+    # Private signed download URL for the generated file, valid for 7 days from
+    # when it was signed. Provided at the top level for convenience so you don't
+    # have to read it out of `file`. When you GET a single execution it is
+    # automatically re-signed if within an hour of expiring; list endpoints do
+    # not re-sign, so there it may be expired (check `downloadUrlExpiresAt`).
+    # See `downloadUrlExpiresAt` for the exact expiry. Null only in the rare
+    # case that the highest-quality rendition is still finalizing.
+    # @return [String]
+    attr_accessor :download_url
+
+    # Seconds since epoch (Unix timestamp) when `downloadUrl` expires. Null only
+    # when `downloadUrl` is null.
+    # @return [Integer]
+    attr_accessor :download_url_expires_at
+
+    # Private signed thumbnail URL for the generated file, valid for 7 days from
+    # when it was signed. Provided at the top level for convenience so you don't
+    # have to read it out of `file`. Re-signed on the same terms as
+    # `downloadUrl` (single-execution GET re-signs when near expiry; list
+    # endpoints do not). Null for file types that have no thumbnail (e.g.
+    # audio).
+    # @return [String]
+    attr_accessor :thumbnail_url
+
+    # Seconds since epoch (Unix timestamp) when `thumbnailUrl` expires. Null
+    # when there is no thumbnail URL.
+    # @return [Integer]
+    attr_accessor :thumbnail_url_expires_at
+
+    # Hydrated file metadata with signed download URLs (always present and
+    # hydrated for a succeeded result). Its signed URLs follow the same 24-hour
+    # validity and automatic re-signing as `downloadUrl`.
+    # @return [FileInfo1]
+    attr_accessor :file
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_id'] = 'fileId'
+      @_hash['type'] = 'type'
+      @_hash['download_url'] = 'downloadUrl'
+      @_hash['download_url_expires_at'] = 'downloadUrlExpiresAt'
+      @_hash['thumbnail_url'] = 'thumbnailUrl'
+      @_hash['thumbnail_url_expires_at'] = 'thumbnailUrlExpiresAt'
+      @_hash['file'] = 'file'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        download_url
+        download_url_expires_at
+        thumbnail_url
+        thumbnail_url_expires_at
+      ]
+    end
+
+    def initialize(file_id:, type:, download_url:, download_url_expires_at:,
+                   thumbnail_url:, thumbnail_url_expires_at:, file:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @file_id = file_id
+      @type = type
+      @download_url = download_url
+      @download_url_expires_at = download_url_expires_at
+      @thumbnail_url = thumbnail_url
+      @thumbnail_url_expires_at = thumbnail_url_expires_at
+      @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.
+      file_id = hash.key?('fileId') ? hash['fileId'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      download_url = hash.key?('downloadUrl') ? hash['downloadUrl'] : nil
+      download_url_expires_at =
+        hash.key?('downloadUrlExpiresAt') ? hash['downloadUrlExpiresAt'] : nil
+      thumbnail_url = hash.key?('thumbnailUrl') ? hash['thumbnailUrl'] : nil
+      thumbnail_url_expires_at =
+        hash.key?('thumbnailUrlExpiresAt') ? hash['thumbnailUrlExpiresAt'] : nil
+      file = FileInfo1.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.
+      ToolSuccessResult.new(file_id: file_id,
+                            type: type,
+                            download_url: download_url,
+                            download_url_expires_at: download_url_expires_at,
+                            thumbnail_url: thumbnail_url,
+                            thumbnail_url_expires_at: thumbnail_url_expires_at,
+                            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} file_id: #{@file_id}, type: #{@type}, download_url: #{@download_url},"\
+      " download_url_expires_at: #{@download_url_expires_at}, thumbnail_url: #{@thumbnail_url},"\
+      " thumbnail_url_expires_at: #{@thumbnail_url_expires_at}, 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} file_id: #{@file_id.inspect}, type: #{@type.inspect}, download_url:"\
+      " #{@download_url.inspect}, download_url_expires_at: #{@download_url_expires_at.inspect},"\
+      " thumbnail_url: #{@thumbnail_url.inspect}, thumbnail_url_expires_at:"\
+      " #{@thumbnail_url_expires_at.inspect}, file: #{@file.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/transcript.rb

@@ -0,0 +1,97 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A transcript of an audio file, as timed words in order.
+  class Transcript < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional BCP-47 language code of the spoken audio (e.g. `en`, `es`). Used
+    # to tag the transcript's language; omit if unknown.
+    # @return [String]
+    attr_accessor :language_code
+
+    # The transcript words, sorted by `startSeconds` and non-overlapping. Must
+    # contain at least one word.
+    # @return [Array[TranscriptWord]]
+    attr_accessor :words
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['language_code'] = 'languageCode'
+      @_hash['words'] = 'words'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        language_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        language_code
+      ]
+    end
+
+    def initialize(words:, language_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @language_code = language_code unless language_code == SKIP
+      @words = words
+      @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
+      words = nil
+      unless hash['words'].nil?
+        words = []
+        hash['words'].each do |structure|
+          words << (TranscriptWord.from_hash(structure) if structure)
+        end
+      end
+
+      words = nil unless hash.key?('words')
+      language_code = hash.key?('languageCode') ? hash['languageCode'] : 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.
+      Transcript.new(words: words,
+                     language_code: language_code,
+                     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} language_code: #{@language_code}, words: #{@words}, 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} language_code: #{@language_code.inspect}, words: #{@words.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end