vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/file_info.rb

@@ -0,0 +1,386 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Metadata for a generated file. Obtain ids from tool results or `GET
+  # /v1/files`.
+  class FileInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # File id (e.g. `vg_file_...`).
+    # @return [String]
+    attr_accessor :file_id
+
+    # File type. Null when the file is still being processed and the type has
+    # not yet been determined.
+    # @return [FileType]
+    attr_accessor :type
+
+    # File scope.
+    # - `GLOBAL`: user-uploaded or standalone generated files that persist
+    # indefinitely.
+    # - `PROJECT`: project-specific files (e.g. text-to-speech clips in a
+    # generated project).
+    # - `EXPORT`: project exports.
+    # - `TEMPORARY`: short-lived files guaranteed to be available for 24 hours,
+    # after which they may be archived at any time. Not analyzed (no
+    # description, transcript, or embedding).
+    # - `ENTITY`: files attached to a reusable entity (e.g. a voice sample for
+    # an actor), shared across your team.
+    # @return [FileInfoScope]
+    attr_accessor :scope
+
+    # Display name for the file.
+    # @return [String]
+    attr_accessor :display_name
+
+    # Display name for the file.
+    # @return [String]
+    attr_accessor :description
+
+    # Duration in seconds for video and audio files. Null for images.
+    # @return [Float]
+    attr_accessor :duration_seconds
+
+    # Timed transcript for video and audio files, when available, as a
+    # `Transcript` object with timed `words`. Null for images or when no
+    # transcript has been generated. For plain transcript text, use
+    # `transcriptText`.
+    # @return [Transcript]
+    attr_accessor :transcript
+
+    # Plain transcript text for video and audio files, when available. Null for
+    # images or when no transcript has been generated.
+    # @return [String]
+    attr_accessor :transcript_text
+
+    # Private signed URL for the highest-quality downloadable rendition,
+    # provided at the top level for convenience. Valid for 7 days from when it
+    # was signed. `null` when the rendition is still processing or the URL has
+    # not been signed yet. See `downloadUrlExpiresAt` for the exact expiry and
+    # `downloadSource` for the full rendition metadata; call `POST
+    # /v1/files/{fileId}/hydrate` to refresh it.
+    # @return [String]
+    attr_accessor :download_url
+
+    # Seconds since epoch (Unix timestamp) when `downloadUrl` expires. `null`
+    # when `downloadUrl` is null.
+    # @return [Integer]
+    attr_accessor :download_url_expires_at
+
+    # Private signed URL for the thumbnail rendition, provided at the top level
+    # for convenience. Valid for 7 days from when it was signed. `null` for file
+    # types that have no thumbnail (e.g. audio) or when it has not been signed
+    # yet. See `thumbnailSource` for the full rendition metadata.
+    # @return [String]
+    attr_accessor :thumbnail_url
+
+    # Seconds since epoch (Unix timestamp) when `thumbnailUrl` expires. `null`
+    # when `thumbnailUrl` is null.
+    # @return [Integer]
+    attr_accessor :thumbnail_url_expires_at
+
+    # Thumbnail image source. Populated after hydration.
+    # @return [FileSource]
+    attr_accessor :thumbnail_source
+
+    # Preview rendition source (720p for video, resized for images). Populated
+    # after hydration.
+    # @return [FileSource]
+    attr_accessor :preview_source
+
+    # Highest-quality downloadable rendition. Populated after hydration.
+    # @return [FileSource]
+    attr_accessor :download_source
+
+    # Private HLS streaming source. Populated for video and audio files once
+    # streaming renditions are ready. Uses a signed token; treat like other
+    # signed sources.
+    # @return [FileSource]
+    attr_accessor :hls_source
+
+    # Whether public preview is enabled for this file. When true,
+    # `staticPublicPreviewSource` is populated for all file types. For video and
+    # audio, `publicHlsUrl` and `publicPlaybackId` are also populated once embed
+    # streaming is ready.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_public_preview_enabled
+
+    # Permanent public URL for the file's highest-quality rendition. Populated
+    # when `isPublicPreviewEnabled` is true. Does not expire (`expiresAt` is
+    # null). Use for direct links to images, downloads, or any file type. For
+    # embedded video or audio players, prefer `publicPlaybackId`.
+    # @return [FileSource]
+    attr_accessor :static_public_preview_source
+
+    # Public HLS streaming URL for video and audio. Only present when
+    # `isPublicPreviewEnabled` is true and embed streaming is ready. Prefer
+    # `publicPlaybackId` with `@videogen/player` for embeds.
+    # @return [String]
+    attr_accessor :public_hls_url
+
+    # Encoded public playback id (e.g. `vg_play_...`) for video and audio
+    # embeds. Pass this to `@videogen/player` or `@videogen/player-react`. Only
+    # present when `isPublicPreviewEnabled` is true and embed streaming is
+    # ready. For a permanent direct file URL (any type), use
+    # `staticPublicPreviewSource` instead.
+    # @return [String]
+    attr_accessor :public_playback_id
+
+    # Tool type that generated this file (e.g. `GENERATE_IMAGE`,
+    # `TEXT_TO_SPEECH`). Only present when the file was created by a tool
+    # execution.
+    # @return [String]
+    attr_accessor :source_tool_type
+
+    # Execution id of the tool call that generated this file (e.g.
+    # `vg_tool_...`). Only present when the file was created by a tool
+    # execution.
+    # @return [String]
+    attr_accessor :source_tool_execution_id
+
+    # Background analysis state for the file (used to populate `description`,
+    # `transcript`, `durationSeconds`, and the search embedding). Omitted when
+    # the file was returned via a path that does not check analysis progress
+    # (e.g. tool-result inline files and webhook payloads).
+    # @return [FileAnalysisMetadata1]
+    attr_accessor :file_analysis_metadata
+
+    # 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['scope'] = 'scope'
+      @_hash['display_name'] = 'displayName'
+      @_hash['description'] = 'description'
+      @_hash['duration_seconds'] = 'durationSeconds'
+      @_hash['transcript'] = 'transcript'
+      @_hash['transcript_text'] = 'transcriptText'
+      @_hash['download_url'] = 'downloadUrl'
+      @_hash['download_url_expires_at'] = 'downloadUrlExpiresAt'
+      @_hash['thumbnail_url'] = 'thumbnailUrl'
+      @_hash['thumbnail_url_expires_at'] = 'thumbnailUrlExpiresAt'
+      @_hash['thumbnail_source'] = 'thumbnailSource'
+      @_hash['preview_source'] = 'previewSource'
+      @_hash['download_source'] = 'downloadSource'
+      @_hash['hls_source'] = 'hlsSource'
+      @_hash['is_public_preview_enabled'] = 'isPublicPreviewEnabled'
+      @_hash['static_public_preview_source'] = 'staticPublicPreviewSource'
+      @_hash['public_hls_url'] = 'publicHlsUrl'
+      @_hash['public_playback_id'] = 'publicPlaybackId'
+      @_hash['source_tool_type'] = 'sourceToolType'
+      @_hash['source_tool_execution_id'] = 'sourceToolExecutionId'
+      @_hash['file_analysis_metadata'] = 'fileAnalysisMetadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        display_name
+        description
+        duration_seconds
+        transcript
+        transcript_text
+        download_url
+        download_url_expires_at
+        thumbnail_url
+        thumbnail_url_expires_at
+        thumbnail_source
+        preview_source
+        download_source
+        hls_source
+        is_public_preview_enabled
+        static_public_preview_source
+        public_hls_url
+        public_playback_id
+        source_tool_type
+        source_tool_execution_id
+        file_analysis_metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        description
+        duration_seconds
+        transcript
+        transcript_text
+        download_url
+        download_url_expires_at
+        thumbnail_url
+        thumbnail_url_expires_at
+        thumbnail_source
+        preview_source
+        download_source
+        hls_source
+        static_public_preview_source
+        public_hls_url
+        public_playback_id
+      ]
+    end
+
+    def initialize(file_id:, scope:, type: SKIP, display_name: SKIP,
+                   description: SKIP, duration_seconds: SKIP, transcript: SKIP,
+                   transcript_text: SKIP, download_url: SKIP,
+                   download_url_expires_at: SKIP, thumbnail_url: SKIP,
+                   thumbnail_url_expires_at: SKIP, thumbnail_source: SKIP,
+                   preview_source: SKIP, download_source: SKIP,
+                   hls_source: SKIP, is_public_preview_enabled: SKIP,
+                   static_public_preview_source: SKIP, public_hls_url: SKIP,
+                   public_playback_id: SKIP, source_tool_type: SKIP,
+                   source_tool_execution_id: SKIP, file_analysis_metadata: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @file_id = file_id
+      @type = type unless type == SKIP
+      @scope = scope
+      @display_name = display_name unless display_name == SKIP
+      @description = description unless description == SKIP
+      @duration_seconds = duration_seconds unless duration_seconds == SKIP
+      @transcript = transcript unless transcript == SKIP
+      @transcript_text = transcript_text unless transcript_text == SKIP
+      @download_url = download_url unless download_url == SKIP
+      @download_url_expires_at = download_url_expires_at unless download_url_expires_at == SKIP
+      @thumbnail_url = thumbnail_url unless thumbnail_url == SKIP
+      @thumbnail_url_expires_at = thumbnail_url_expires_at unless thumbnail_url_expires_at == SKIP
+      @thumbnail_source = thumbnail_source unless thumbnail_source == SKIP
+      @preview_source = preview_source unless preview_source == SKIP
+      @download_source = download_source unless download_source == SKIP
+      @hls_source = hls_source unless hls_source == SKIP
+      unless is_public_preview_enabled == SKIP
+        @is_public_preview_enabled =
+          is_public_preview_enabled
+      end
+      unless static_public_preview_source == SKIP
+        @static_public_preview_source =
+          static_public_preview_source
+      end
+      @public_hls_url = public_hls_url unless public_hls_url == SKIP
+      @public_playback_id = public_playback_id unless public_playback_id == SKIP
+      @source_tool_type = source_tool_type unless source_tool_type == SKIP
+      @source_tool_execution_id = source_tool_execution_id unless source_tool_execution_id == SKIP
+      @file_analysis_metadata = file_analysis_metadata unless file_analysis_metadata == 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
+      scope = hash.key?('scope') ? hash['scope'] : nil
+      type = hash.key?('type') ? hash['type'] : SKIP
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      duration_seconds =
+        hash.key?('durationSeconds') ? hash['durationSeconds'] : SKIP
+      transcript = Transcript.from_hash(hash['transcript']) if hash['transcript']
+      transcript_text =
+        hash.key?('transcriptText') ? hash['transcriptText'] : SKIP
+      download_url = hash.key?('downloadUrl') ? hash['downloadUrl'] : SKIP
+      download_url_expires_at =
+        hash.key?('downloadUrlExpiresAt') ? hash['downloadUrlExpiresAt'] : SKIP
+      thumbnail_url = hash.key?('thumbnailUrl') ? hash['thumbnailUrl'] : SKIP
+      thumbnail_url_expires_at =
+        hash.key?('thumbnailUrlExpiresAt') ? hash['thumbnailUrlExpiresAt'] : SKIP
+      thumbnail_source = FileSource.from_hash(hash['thumbnailSource']) if hash['thumbnailSource']
+      preview_source = FileSource.from_hash(hash['previewSource']) if hash['previewSource']
+      download_source = FileSource.from_hash(hash['downloadSource']) if hash['downloadSource']
+      hls_source = FileSource.from_hash(hash['hlsSource']) if hash['hlsSource']
+      is_public_preview_enabled =
+        hash.key?('isPublicPreviewEnabled') ? hash['isPublicPreviewEnabled'] : SKIP
+      static_public_preview_source = FileSource.from_hash(hash['staticPublicPreviewSource']) if
+        hash['staticPublicPreviewSource']
+      public_hls_url = hash.key?('publicHlsUrl') ? hash['publicHlsUrl'] : SKIP
+      public_playback_id =
+        hash.key?('publicPlaybackId') ? hash['publicPlaybackId'] : SKIP
+      source_tool_type =
+        hash.key?('sourceToolType') ? hash['sourceToolType'] : SKIP
+      source_tool_execution_id =
+        hash.key?('sourceToolExecutionId') ? hash['sourceToolExecutionId'] : SKIP
+      file_analysis_metadata = FileAnalysisMetadata1.from_hash(hash['fileAnalysisMetadata']) if
+        hash['fileAnalysisMetadata']
+
+      # 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.
+      FileInfo.new(file_id: file_id,
+                   scope: scope,
+                   type: type,
+                   display_name: display_name,
+                   description: description,
+                   duration_seconds: duration_seconds,
+                   transcript: transcript,
+                   transcript_text: transcript_text,
+                   download_url: download_url,
+                   download_url_expires_at: download_url_expires_at,
+                   thumbnail_url: thumbnail_url,
+                   thumbnail_url_expires_at: thumbnail_url_expires_at,
+                   thumbnail_source: thumbnail_source,
+                   preview_source: preview_source,
+                   download_source: download_source,
+                   hls_source: hls_source,
+                   is_public_preview_enabled: is_public_preview_enabled,
+                   static_public_preview_source: static_public_preview_source,
+                   public_hls_url: public_hls_url,
+                   public_playback_id: public_playback_id,
+                   source_tool_type: source_tool_type,
+                   source_tool_execution_id: source_tool_execution_id,
+                   file_analysis_metadata: file_analysis_metadata,
+                   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}, scope: #{@scope}, display_name:"\
+      " #{@display_name}, description: #{@description}, duration_seconds: #{@duration_seconds},"\
+      " transcript: #{@transcript}, transcript_text: #{@transcript_text}, download_url:"\
+      " #{@download_url}, download_url_expires_at: #{@download_url_expires_at}, thumbnail_url:"\
+      " #{@thumbnail_url}, thumbnail_url_expires_at: #{@thumbnail_url_expires_at},"\
+      " thumbnail_source: #{@thumbnail_source}, preview_source: #{@preview_source},"\
+      " download_source: #{@download_source}, hls_source: #{@hls_source},"\
+      " is_public_preview_enabled: #{@is_public_preview_enabled}, static_public_preview_source:"\
+      " #{@static_public_preview_source}, public_hls_url: #{@public_hls_url}, public_playback_id:"\
+      " #{@public_playback_id}, source_tool_type: #{@source_tool_type}, source_tool_execution_id:"\
+      " #{@source_tool_execution_id}, file_analysis_metadata: #{@file_analysis_metadata},"\
+      " 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}, scope:"\
+      " #{@scope.inspect}, display_name: #{@display_name.inspect}, description:"\
+      " #{@description.inspect}, duration_seconds: #{@duration_seconds.inspect}, transcript:"\
+      " #{@transcript.inspect}, transcript_text: #{@transcript_text.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}, thumbnail_source: #{@thumbnail_source.inspect},"\
+      " preview_source: #{@preview_source.inspect}, download_source: #{@download_source.inspect},"\
+      " hls_source: #{@hls_source.inspect}, is_public_preview_enabled:"\
+      " #{@is_public_preview_enabled.inspect}, static_public_preview_source:"\
+      " #{@static_public_preview_source.inspect}, public_hls_url: #{@public_hls_url.inspect},"\
+      " public_playback_id: #{@public_playback_id.inspect}, source_tool_type:"\
+      " #{@source_tool_type.inspect}, source_tool_execution_id:"\
+      " #{@source_tool_execution_id.inspect}, file_analysis_metadata:"\
+      " #{@file_analysis_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end