vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/motion_graphic_sub_tool_mode2.rb

@@ -0,0 +1,41 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Whether the motion graphic may generate video clips. Requires a paid plan.
+  # Defaults to AUTO.
+  class MotionGraphicSubToolMode2
+    MOTION_GRAPHIC_SUB_TOOL_MODE2 = [
+      # TODO: Write general description for AUTO
+      AUTO = 'AUTO'.freeze,
+
+      # TODO: Write general description for ENABLED
+      ENABLED = 'ENABLED'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'DISABLED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MOTION_GRAPHIC_SUB_TOOL_MODE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auto' then AUTO
+      when 'enabled' then ENABLED
+      when 'disabled' then DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/motion_graphic_sub_tool_mode3.rb

@@ -0,0 +1,40 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Whether the motion graphic may generate voiceover audio. Defaults to AUTO.
+  class MotionGraphicSubToolMode3
+    MOTION_GRAPHIC_SUB_TOOL_MODE3 = [
+      # TODO: Write general description for AUTO
+      AUTO = 'AUTO'.freeze,
+
+      # TODO: Write general description for ENABLED
+      ENABLED = 'ENABLED'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'DISABLED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MOTION_GRAPHIC_SUB_TOOL_MODE3.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auto' then AUTO
+      when 'enabled' then ENABLED
+      when 'disabled' then DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/motion_graphic_sub_tool_mode4.rb

@@ -0,0 +1,40 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Whether the motion graphic may search stock media. Defaults to AUTO.
+  class MotionGraphicSubToolMode4
+    MOTION_GRAPHIC_SUB_TOOL_MODE4 = [
+      # TODO: Write general description for AUTO
+      AUTO = 'AUTO'.freeze,
+
+      # TODO: Write general description for ENABLED
+      ENABLED = 'ENABLED'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'DISABLED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MOTION_GRAPHIC_SUB_TOOL_MODE4.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auto' then AUTO
+      when 'enabled' then ENABLED
+      when 'disabled' then DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/motion_graphic_sub_tool_modes.rb

@@ -0,0 +1,114 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Per-capability access modes for a motion graphic. Any omitted capability
+  # defaults to AUTO.
+  class MotionGraphicSubToolModes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether the motion graphic may generate images. Defaults to AUTO.
+    # @return [MotionGraphicSubToolMode1]
+    attr_accessor :generate_images
+
+    # Whether the motion graphic may generate video clips. Requires a paid plan.
+    # Defaults to AUTO.
+    # @return [MotionGraphicSubToolMode2]
+    attr_accessor :generate_video_clips
+
+    # Whether the motion graphic may generate voiceover audio. Defaults to AUTO.
+    # @return [MotionGraphicSubToolMode3]
+    attr_accessor :generate_voiceover
+
+    # Whether the motion graphic may search stock media. Defaults to AUTO.
+    # @return [MotionGraphicSubToolMode4]
+    attr_accessor :search_stock_media
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['generate_images'] = 'generateImages'
+      @_hash['generate_video_clips'] = 'generateVideoClips'
+      @_hash['generate_voiceover'] = 'generateVoiceover'
+      @_hash['search_stock_media'] = 'searchStockMedia'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        generate_images
+        generate_video_clips
+        generate_voiceover
+        search_stock_media
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(generate_images: SKIP, generate_video_clips: SKIP,
+                   generate_voiceover: SKIP, search_stock_media: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @generate_images = generate_images unless generate_images == SKIP
+      @generate_video_clips = generate_video_clips unless generate_video_clips == SKIP
+      @generate_voiceover = generate_voiceover unless generate_voiceover == SKIP
+      @search_stock_media = search_stock_media unless search_stock_media == 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.
+      generate_images =
+        hash.key?('generateImages') ? hash['generateImages'] : SKIP
+      generate_video_clips =
+        hash.key?('generateVideoClips') ? hash['generateVideoClips'] : SKIP
+      generate_voiceover =
+        hash.key?('generateVoiceover') ? hash['generateVoiceover'] : SKIP
+      search_stock_media =
+        hash.key?('searchStockMedia') ? hash['searchStockMedia'] : 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.
+      MotionGraphicSubToolModes.new(generate_images: generate_images,
+                                    generate_video_clips: generate_video_clips,
+                                    generate_voiceover: generate_voiceover,
+                                    search_stock_media: search_stock_media,
+                                    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} generate_images: #{@generate_images}, generate_video_clips:"\
+      " #{@generate_video_clips}, generate_voiceover: #{@generate_voiceover}, search_stock_media:"\
+      " #{@search_stock_media}, 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} generate_images: #{@generate_images.inspect}, generate_video_clips:"\
+      " #{@generate_video_clips.inspect}, generate_voiceover: #{@generate_voiceover.inspect},"\
+      " search_stock_media: #{@search_stock_media.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/motion_graphic_sub_tool_modes1.rb

@@ -0,0 +1,116 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Optional per-capability controls for the media the motion graphic may
+  # generate or fetch (generated images, generated video clips, generated
+  # voiceover, and stock media search). Each capability is AUTO, ENABLED, or
+  # DISABLED. Omit to use AUTO for every capability.
+  class MotionGraphicSubToolModes1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether the motion graphic may generate images. Defaults to AUTO.
+    # @return [MotionGraphicSubToolMode1]
+    attr_accessor :generate_images
+
+    # Whether the motion graphic may generate video clips. Requires a paid plan.
+    # Defaults to AUTO.
+    # @return [MotionGraphicSubToolMode2]
+    attr_accessor :generate_video_clips
+
+    # Whether the motion graphic may generate voiceover audio. Defaults to AUTO.
+    # @return [MotionGraphicSubToolMode3]
+    attr_accessor :generate_voiceover
+
+    # Whether the motion graphic may search stock media. Defaults to AUTO.
+    # @return [MotionGraphicSubToolMode4]
+    attr_accessor :search_stock_media
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['generate_images'] = 'generateImages'
+      @_hash['generate_video_clips'] = 'generateVideoClips'
+      @_hash['generate_voiceover'] = 'generateVoiceover'
+      @_hash['search_stock_media'] = 'searchStockMedia'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        generate_images
+        generate_video_clips
+        generate_voiceover
+        search_stock_media
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(generate_images: SKIP, generate_video_clips: SKIP,
+                   generate_voiceover: SKIP, search_stock_media: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @generate_images = generate_images unless generate_images == SKIP
+      @generate_video_clips = generate_video_clips unless generate_video_clips == SKIP
+      @generate_voiceover = generate_voiceover unless generate_voiceover == SKIP
+      @search_stock_media = search_stock_media unless search_stock_media == 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.
+      generate_images =
+        hash.key?('generateImages') ? hash['generateImages'] : SKIP
+      generate_video_clips =
+        hash.key?('generateVideoClips') ? hash['generateVideoClips'] : SKIP
+      generate_voiceover =
+        hash.key?('generateVoiceover') ? hash['generateVoiceover'] : SKIP
+      search_stock_media =
+        hash.key?('searchStockMedia') ? hash['searchStockMedia'] : 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.
+      MotionGraphicSubToolModes1.new(generate_images: generate_images,
+                                     generate_video_clips: generate_video_clips,
+                                     generate_voiceover: generate_voiceover,
+                                     search_stock_media: search_stock_media,
+                                     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} generate_images: #{@generate_images}, generate_video_clips:"\
+      " #{@generate_video_clips}, generate_voiceover: #{@generate_voiceover}, search_stock_media:"\
+      " #{@search_stock_media}, 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} generate_images: #{@generate_images.inspect}, generate_video_clips:"\
+      " #{@generate_video_clips.inspect}, generate_voiceover: #{@generate_voiceover.inspect},"\
+      " search_stock_media: #{@search_stock_media.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/project_export.rb

@@ -0,0 +1,207 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ProjectExport Model.
+  class ProjectExport < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque export id (e.g. `vg_expo_...`) matching the original request.
+    # @return [String]
+    attr_accessor :export_id
+
+    # Id of the exported project (e.g. `vg_proj_...`).
+    # @return [String]
+    attr_accessor :project_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
+
+    # 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 export attempt.
+    # @return [Integer]
+    attr_accessor :attempt_index
+
+    # Private signed MP4 download URL, 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, so a fresh call to get the export always returns a URL valid
+    # long enough to use. See `downloadUrlExpiresAt` for the exact expiry. To
+    # fetch a fresh URL directly from the underlying file at any time, use
+    # `exportFileId` 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
+
+    # Private signed thumbnail URL, valid for 7 days from when it was signed.
+    # Always present as a field; `null` until `status` is `succeeded` (and when
+    # no thumbnail is available). Re-signed automatically on the same terms as
+    # `downloadUrl`.
+    # @return [String]
+    attr_accessor :thumbnail_url
+
+    # Seconds since epoch (Unix timestamp) when `thumbnailUrl` expires. `null`
+    # while `thumbnailUrl` is null.
+    # @return [Integer]
+    attr_accessor :thumbnail_url_expires_at
+
+    # File id (e.g. `vg_file_...`) of the exported MP4. 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, which is useful once the 24-hour URLs above have
+    # expired.
+    # @return [String]
+    attr_accessor :export_file_id
+
+    # Hydrated export file metadata with signed download URLs. Always present as
+    # a field; `null` until `status` is `succeeded`. Its signed URLs follow 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['export_id'] = 'exportId'
+      @_hash['project_id'] = 'projectId'
+      @_hash['status'] = 'status'
+      @_hash['progress_percentage'] = 'progressPercentage'
+      @_hash['attempt_index'] = 'attemptIndex'
+      @_hash['download_url'] = 'downloadUrl'
+      @_hash['download_url_expires_at'] = 'downloadUrlExpiresAt'
+      @_hash['thumbnail_url'] = 'thumbnailUrl'
+      @_hash['thumbnail_url_expires_at'] = 'thumbnailUrlExpiresAt'
+      @_hash['export_file_id'] = 'exportFileId'
+      @_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
+        thumbnail_url
+        thumbnail_url_expires_at
+        export_file_id
+        file
+        error
+      ]
+    end
+
+    def initialize(export_id:, project_id:, status:, progress_percentage:,
+                   attempt_index:, download_url:, download_url_expires_at:,
+                   thumbnail_url:, thumbnail_url_expires_at:, export_file_id:,
+                   file:, error:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @export_id = export_id
+      @project_id = project_id
+      @status = status
+      @progress_percentage = progress_percentage
+      @attempt_index = attempt_index
+      @download_url = download_url
+      @download_url_expires_at = download_url_expires_at
+      @thumbnail_url = thumbnail_url
+      @thumbnail_url_expires_at = thumbnail_url_expires_at
+      @export_file_id = export_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.
+      export_id = hash.key?('exportId') ? hash['exportId'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : 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
+      thumbnail_url = hash.key?('thumbnailUrl') ? hash['thumbnailUrl'] : nil
+      thumbnail_url_expires_at =
+        hash.key?('thumbnailUrlExpiresAt') ? hash['thumbnailUrlExpiresAt'] : nil
+      export_file_id = hash.key?('exportFileId') ? hash['exportFileId'] : 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.
+      ProjectExport.new(export_id: export_id,
+                        project_id: project_id,
+                        status: status,
+                        progress_percentage: progress_percentage,
+                        attempt_index: attempt_index,
+                        download_url: download_url,
+                        download_url_expires_at: download_url_expires_at,
+                        thumbnail_url: thumbnail_url,
+                        thumbnail_url_expires_at: thumbnail_url_expires_at,
+                        export_file_id: export_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} export_id: #{@export_id}, project_id: #{@project_id}, status: #{@status},"\
+      " progress_percentage: #{@progress_percentage}, attempt_index: #{@attempt_index},"\
+      " download_url: #{@download_url}, download_url_expires_at: #{@download_url_expires_at},"\
+      " thumbnail_url: #{@thumbnail_url}, thumbnail_url_expires_at: #{@thumbnail_url_expires_at},"\
+      " export_file_id: #{@export_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} export_id: #{@export_id.inspect}, project_id: #{@project_id.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}, thumbnail_url:"\
+      " #{@thumbnail_url.inspect}, thumbnail_url_expires_at: #{@thumbnail_url_expires_at.inspect},"\
+      " export_file_id: #{@export_file_id.inspect}, file: #{@file.inspect}, error:"\
+      " #{@error.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end