vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/export_project_request.rb

@@ -0,0 +1,124 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ExportProjectRequest Model.
+  class ExportProjectRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Vertical resolution tier for the rendered MP4.
+    # @return [ExportProjectQuality]
+    attr_accessor :quality
+
+    # Controls whether the VideoGen watermark is applied to the output. `AUTO`
+    # applies the watermark unless you have a Pro plan. `VIDEO_GEN` always
+    # applies it. `NONE` removes the watermark (requires Pro; returns an error
+    # if you don't have it).
+    # @return [WatermarkMode]
+    attr_accessor :watermark_mode
+
+    # Controls whether a short 'Made with VideoGen' end screen is appended to
+    # the output. `AUTO` appends it unless you have a Pro plan. `VIDEO_GEN`
+    # always appends it. `NONE` removes it (requires Pro; returns an error if
+    # you don't have it).
+    # @return [EndScreenMode]
+    attr_accessor :end_screen_mode
+
+    # Destinations to deliver the finished export to when it completes, in
+    # addition to any delivery destinations already saved for the team. Each
+    # destination references a connected integration.
+    # @return [Array[ExportDeliveryDestination]]
+    attr_accessor :delivery_destinations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quality'] = 'quality'
+      @_hash['watermark_mode'] = 'watermarkMode'
+      @_hash['end_screen_mode'] = 'endScreenMode'
+      @_hash['delivery_destinations'] = 'deliveryDestinations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        quality
+        watermark_mode
+        end_screen_mode
+        delivery_destinations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(quality: SKIP, watermark_mode: WatermarkMode::AUTO,
+                   end_screen_mode: EndScreenMode::AUTO,
+                   delivery_destinations: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @quality = quality unless quality == SKIP
+      @watermark_mode = watermark_mode unless watermark_mode == SKIP
+      @end_screen_mode = end_screen_mode unless end_screen_mode == SKIP
+      @delivery_destinations = delivery_destinations unless delivery_destinations == 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.
+      quality = hash.key?('quality') ? hash['quality'] : SKIP
+      watermark_mode = hash['watermarkMode'] ||= WatermarkMode::AUTO
+      end_screen_mode = hash['endScreenMode'] ||= EndScreenMode::AUTO
+      # Parameter is an array, so we need to iterate through it
+      delivery_destinations = nil
+      unless hash['deliveryDestinations'].nil?
+        delivery_destinations = []
+        hash['deliveryDestinations'].each do |structure|
+          delivery_destinations << (ExportDeliveryDestination.from_hash(structure) if structure)
+        end
+      end
+
+      delivery_destinations = SKIP unless hash.key?('deliveryDestinations')
+
+      # 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.
+      ExportProjectRequest.new(quality: quality,
+                               watermark_mode: watermark_mode,
+                               end_screen_mode: end_screen_mode,
+                               delivery_destinations: delivery_destinations,
+                               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} quality: #{@quality}, watermark_mode: #{@watermark_mode}, end_screen_mode:"\
+      " #{@end_screen_mode}, delivery_destinations: #{@delivery_destinations},"\
+      " 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} quality: #{@quality.inspect}, watermark_mode: #{@watermark_mode.inspect},"\
+      " end_screen_mode: #{@end_screen_mode.inspect}, delivery_destinations:"\
+      " #{@delivery_destinations.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/export_project_response.rb

@@ -0,0 +1,76 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ExportProjectResponse Model.
+  class ExportProjectResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque export id (e.g. `vg_expo_...`). Poll `GET
+    # /v1/projects/{projectId}/exports/{exportId}` or subscribe to webhooks for
+    # completion.
+    # @return [String]
+    attr_accessor :export_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['export_id'] = 'exportId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(export_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @export_id = export_id
+      @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
+
+      # 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.
+      ExportProjectResponse.new(export_id: export_id,
+                                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}, 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}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/file_analysis_metadata.rb

@@ -0,0 +1,112 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Background analysis state for a file. Background analysis populates
+  # `description`, `transcript`, `durationSeconds`, and the search embedding
+  # after a file is uploaded or generated; this object lets you render a
+  # progress indicator while it runs (and skip rendering once it's done).
+  class FileAnalysisMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Coarse-grained analysis state.
+    # - `UNATTEMPTED`: analysis has not started yet.
+    # - `LOADING`: analysis is in progress.
+    # - `FULFILLED`: analysis completed successfully. `description`,
+    # `transcript`, and `durationSeconds` are now populated where applicable for
+    # the file's type.
+    # - `REJECTED`: analysis failed permanently and will not be retried.
+    # @return [FileAnalysisMetadataAnalysisLoadingState]
+    attr_accessor :analysis_loading_state
+
+    # Progress in `[0, 100]`. Always `100` when `analysisLoadingState` is
+    # `FULFILLED`. Otherwise the most recent in-flight progress reported by the
+    # analysis task (or `0` if no progress has been reported yet).
+    # @return [Float]
+    attr_accessor :analysis_progress_percentage
+
+    # Zero-based index of the current analysis task attempt. Only present while
+    # analysis is still loading (`UNATTEMPTED` or `LOADING`); omitted once
+    # analysis reaches a terminal state.
+    # @return [Integer]
+    attr_accessor :analysis_attempt_index
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['analysis_loading_state'] = 'analysisLoadingState'
+      @_hash['analysis_progress_percentage'] = 'analysisProgressPercentage'
+      @_hash['analysis_attempt_index'] = 'analysisAttemptIndex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        analysis_attempt_index
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(analysis_loading_state:, analysis_progress_percentage:,
+                   analysis_attempt_index: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @analysis_loading_state = analysis_loading_state
+      @analysis_progress_percentage = analysis_progress_percentage
+      @analysis_attempt_index = analysis_attempt_index unless analysis_attempt_index == 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.
+      analysis_loading_state =
+        hash.key?('analysisLoadingState') ? hash['analysisLoadingState'] : nil
+      analysis_progress_percentage =
+        hash.key?('analysisProgressPercentage') ? hash['analysisProgressPercentage'] : nil
+      analysis_attempt_index =
+        hash.key?('analysisAttemptIndex') ? hash['analysisAttemptIndex'] : 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.
+      FileAnalysisMetadata.new(analysis_loading_state: analysis_loading_state,
+                               analysis_progress_percentage: analysis_progress_percentage,
+                               analysis_attempt_index: analysis_attempt_index,
+                               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} analysis_loading_state: #{@analysis_loading_state},"\
+      " analysis_progress_percentage: #{@analysis_progress_percentage}, analysis_attempt_index:"\
+      " #{@analysis_attempt_index}, 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} analysis_loading_state: #{@analysis_loading_state.inspect},"\
+      " analysis_progress_percentage: #{@analysis_progress_percentage.inspect},"\
+      " analysis_attempt_index: #{@analysis_attempt_index.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/file_analysis_metadata1.rb

@@ -0,0 +1,112 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # 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).
+  class FileAnalysisMetadata1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Coarse-grained analysis state.
+    # - `UNATTEMPTED`: analysis has not started yet.
+    # - `LOADING`: analysis is in progress.
+    # - `FULFILLED`: analysis completed successfully. `description`,
+    # `transcript`, and `durationSeconds` are now populated where applicable for
+    # the file's type.
+    # - `REJECTED`: analysis failed permanently and will not be retried.
+    # @return [FileAnalysisMetadataAnalysisLoadingState]
+    attr_accessor :analysis_loading_state
+
+    # Progress in `[0, 100]`. Always `100` when `analysisLoadingState` is
+    # `FULFILLED`. Otherwise the most recent in-flight progress reported by the
+    # analysis task (or `0` if no progress has been reported yet).
+    # @return [Float]
+    attr_accessor :analysis_progress_percentage
+
+    # Zero-based index of the current analysis task attempt. Only present while
+    # analysis is still loading (`UNATTEMPTED` or `LOADING`); omitted once
+    # analysis reaches a terminal state.
+    # @return [Integer]
+    attr_accessor :analysis_attempt_index
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['analysis_loading_state'] = 'analysisLoadingState'
+      @_hash['analysis_progress_percentage'] = 'analysisProgressPercentage'
+      @_hash['analysis_attempt_index'] = 'analysisAttemptIndex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        analysis_attempt_index
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(analysis_loading_state:, analysis_progress_percentage:,
+                   analysis_attempt_index: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @analysis_loading_state = analysis_loading_state
+      @analysis_progress_percentage = analysis_progress_percentage
+      @analysis_attempt_index = analysis_attempt_index unless analysis_attempt_index == 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.
+      analysis_loading_state =
+        hash.key?('analysisLoadingState') ? hash['analysisLoadingState'] : nil
+      analysis_progress_percentage =
+        hash.key?('analysisProgressPercentage') ? hash['analysisProgressPercentage'] : nil
+      analysis_attempt_index =
+        hash.key?('analysisAttemptIndex') ? hash['analysisAttemptIndex'] : 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.
+      FileAnalysisMetadata1.new(analysis_loading_state: analysis_loading_state,
+                                analysis_progress_percentage: analysis_progress_percentage,
+                                analysis_attempt_index: analysis_attempt_index,
+                                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} analysis_loading_state: #{@analysis_loading_state},"\
+      " analysis_progress_percentage: #{@analysis_progress_percentage}, analysis_attempt_index:"\
+      " #{@analysis_attempt_index}, 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} analysis_loading_state: #{@analysis_loading_state.inspect},"\
+      " analysis_progress_percentage: #{@analysis_progress_percentage.inspect},"\
+      " analysis_attempt_index: #{@analysis_attempt_index.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/file_analysis_metadata_analysis_loading_state.rb

@@ -0,0 +1,48 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Coarse-grained analysis state. - `UNATTEMPTED`: analysis has not started
+  # yet. - `LOADING`: analysis is in progress. - `FULFILLED`: analysis completed
+  # successfully. `description`, `transcript`, and `durationSeconds` are now
+  # populated where applicable for the file's type. - `REJECTED`: analysis
+  # failed permanently and will not be retried.
+  class FileAnalysisMetadataAnalysisLoadingState
+    FILE_ANALYSIS_METADATA_ANALYSIS_LOADING_STATE = [
+      # TODO: Write general description for UNATTEMPTED
+      UNATTEMPTED = 'UNATTEMPTED'.freeze,
+
+      # TODO: Write general description for LOADING
+      LOADING = 'LOADING'.freeze,
+
+      # TODO: Write general description for FULFILLED
+      FULFILLED = 'FULFILLED'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILE_ANALYSIS_METADATA_ANALYSIS_LOADING_STATE.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNATTEMPTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unattempted' then UNATTEMPTED
+      when 'loading' then LOADING
+      when 'fulfilled' then FULFILLED
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end