vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/entity_entity_type.rb

@@ -0,0 +1,47 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ACTOR features a consistent character; PRODUCT features a consistent product
+  # or object; VISUAL_STYLE guides the look of generated images; SLIDESHOW_THEME
+  # is a shared slide design system (fonts, colors, layout) applied to every
+  # slide of a slideshow-to-video deck.
+  class EntityEntityType
+    ENTITY_ENTITY_TYPE = [
+      # TODO: Write general description for ACTOR
+      ACTOR = 'ACTOR'.freeze,
+
+      # TODO: Write general description for PRODUCT
+      PRODUCT = 'PRODUCT'.freeze,
+
+      # TODO: Write general description for VISUAL_STYLE
+      VISUAL_STYLE = 'VISUAL_STYLE'.freeze,
+
+      # TODO: Write general description for SLIDESHOW_THEME
+      SLIDESHOW_THEME = 'SLIDESHOW_THEME'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ENTITY_ENTITY_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTOR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'actor' then ACTOR
+      when 'product' then PRODUCT
+      when 'visual_style' then VISUAL_STYLE
+      when 'slideshow_theme' then SLIDESHOW_THEME
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/entity_reference.rb

@@ -0,0 +1,93 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A file attached to an entity as a reference image.
+  class EntityReference < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reference image file id (e.g. `vg_file_...`). Hydrate it via `GET
+    # /v1/files/{fileId}` to fetch a viewable URL.
+    # @return [String]
+    attr_accessor :file_id
+
+    # Optional description of the reference. Empty string when not set.
+    # @return [String]
+    attr_accessor :description
+
+    # When true, this is the entity's primary reference (used for its
+    # thumbnail).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_default
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_id'] = 'fileId'
+      @_hash['description'] = 'description'
+      @_hash['is_default'] = 'isDefault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(file_id:, description:, is_default:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @file_id = file_id
+      @description = description
+      @is_default = is_default
+      @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
+      description = hash.key?('description') ? hash['description'] : nil
+      is_default = hash.key?('isDefault') ? hash['isDefault'] : 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.
+      EntityReference.new(file_id: file_id,
+                          description: description,
+                          is_default: is_default,
+                          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}, description: #{@description}, is_default:"\
+      " #{@is_default}, 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}, description: #{@description.inspect},"\
+      " is_default: #{@is_default.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/error_requirement.rb

@@ -0,0 +1,101 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # What is needed to resolve an error, when it can be fixed by fulfilling a
+  # specific requirement (e.g. purchasing an add-on or upgrading the plan).
+  class ErrorRequirement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Machine-readable requirement type in snake_case (e.g. `purchase_add_on`,
+    # `upgrade_plan`).
+    # @return [String]
+    attr_accessor :type
+
+    # Key-value pairs with requirement-specific context (e.g. the add-on id to
+    # purchase).
+    # @return [Hash[String, String]]
+    attr_accessor :details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['details'] = 'details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, details: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @details = details unless details == 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.
+      type = hash.key?('type') ? hash['type'] : nil
+      details = hash.key?('details') ? hash['details'] : 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.
+      ErrorRequirement.new(type: type,
+                           details: details,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ErrorRequirement | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, details: #{@details}, 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}, details: #{@details.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/executed_tool.rb

@@ -0,0 +1,148 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ExecutedTool Model.
+  class ExecutedTool < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Execution id matching the original request.
+    # @return [String]
+    attr_accessor :tool_execution_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
+
+    # Tool name (e.g. `GENERATE_IMAGE`, `TEXT_TO_SPEECH`).
+    # @return [String]
+    attr_accessor :tool_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
+
+    # One entry per generated result. Always present; empty until `status` is
+    # `succeeded`, then one entry per generated file (each with signed URLs and
+    # a hydrated `file`).
+    # @return [Array[ToolSuccessResult]]
+    attr_accessor :results
+
+    # Error details. Always present; `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['tool_execution_id'] = 'toolExecutionId'
+      @_hash['status'] = 'status'
+      @_hash['tool_type'] = 'toolType'
+      @_hash['progress_percentage'] = 'progressPercentage'
+      @_hash['attempt_index'] = 'attemptIndex'
+      @_hash['results'] = 'results'
+      @_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(tool_execution_id:, status:, tool_type:,
+                   progress_percentage:, attempt_index:, results:, error:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tool_execution_id = tool_execution_id
+      @status = status
+      @tool_type = tool_type
+      @progress_percentage = progress_percentage
+      @attempt_index = attempt_index
+      @results = results
+      @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.
+      tool_execution_id =
+        hash.key?('toolExecutionId') ? hash['toolExecutionId'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      tool_type = hash.key?('toolType') ? hash['toolType'] : nil
+      progress_percentage =
+        hash.key?('progressPercentage') ? hash['progressPercentage'] : nil
+      attempt_index = hash.key?('attemptIndex') ? hash['attemptIndex'] : nil
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (ToolSuccessResult.from_hash(structure) if structure)
+        end
+      end
+
+      results = nil unless hash.key?('results')
+      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.
+      ExecutedTool.new(tool_execution_id: tool_execution_id,
+                       status: status,
+                       tool_type: tool_type,
+                       progress_percentage: progress_percentage,
+                       attempt_index: attempt_index,
+                       results: results,
+                       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} tool_execution_id: #{@tool_execution_id}, status: #{@status}, tool_type:"\
+      " #{@tool_type}, progress_percentage: #{@progress_percentage}, attempt_index:"\
+      " #{@attempt_index}, results: #{@results}, 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} tool_execution_id: #{@tool_execution_id.inspect}, status:"\
+      " #{@status.inspect}, tool_type: #{@tool_type.inspect}, progress_percentage:"\
+      " #{@progress_percentage.inspect}, attempt_index: #{@attempt_index.inspect}, results:"\
+      " #{@results.inspect}, error: #{@error.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/export_delivery_destination.rb

@@ -0,0 +1,110 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ExportDeliveryDestination Model.
+  class ExportDeliveryDestination < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Id of the connected integration that will receive this export.
+    # @return [String]
+    attr_accessor :integration_connection_id
+
+    # Where to deliver the export within the connected integration.
+    # @return [ExportDeliveryDestinationType]
+    attr_accessor :type
+
+    # Target channel id. Required when `type` is `SLACK_CHANNEL`.
+    # @return [String]
+    attr_accessor :slack_channel_id
+
+    # Target folder id. Required when `type` is `GOOGLE_DRIVE_FOLDER`.
+    # @return [String]
+    attr_accessor :google_drive_folder_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['integration_connection_id'] = 'integrationConnectionId'
+      @_hash['type'] = 'type'
+      @_hash['slack_channel_id'] = 'slackChannelId'
+      @_hash['google_drive_folder_id'] = 'googleDriveFolderId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        slack_channel_id
+        google_drive_folder_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        slack_channel_id
+        google_drive_folder_id
+      ]
+    end
+
+    def initialize(integration_connection_id:, type:, slack_channel_id: SKIP,
+                   google_drive_folder_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @integration_connection_id = integration_connection_id
+      @type = type
+      @slack_channel_id = slack_channel_id unless slack_channel_id == SKIP
+      @google_drive_folder_id = google_drive_folder_id unless google_drive_folder_id == 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.
+      integration_connection_id =
+        hash.key?('integrationConnectionId') ? hash['integrationConnectionId'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      slack_channel_id =
+        hash.key?('slackChannelId') ? hash['slackChannelId'] : SKIP
+      google_drive_folder_id =
+        hash.key?('googleDriveFolderId') ? hash['googleDriveFolderId'] : 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.
+      ExportDeliveryDestination.new(integration_connection_id: integration_connection_id,
+                                    type: type,
+                                    slack_channel_id: slack_channel_id,
+                                    google_drive_folder_id: google_drive_folder_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} integration_connection_id: #{@integration_connection_id}, type: #{@type},"\
+      " slack_channel_id: #{@slack_channel_id}, google_drive_folder_id:"\
+      " #{@google_drive_folder_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} integration_connection_id: #{@integration_connection_id.inspect}, type:"\
+      " #{@type.inspect}, slack_channel_id: #{@slack_channel_id.inspect}, google_drive_folder_id:"\
+      " #{@google_drive_folder_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/export_delivery_destination_type.rb

@@ -0,0 +1,36 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Where to deliver the export within the connected integration.
+  class ExportDeliveryDestinationType
+    EXPORT_DELIVERY_DESTINATION_TYPE = [
+      # TODO: Write general description for SLACK_CHANNEL
+      SLACK_CHANNEL = 'SLACK_CHANNEL'.freeze,
+
+      # TODO: Write general description for GOOGLE_DRIVE_FOLDER
+      GOOGLE_DRIVE_FOLDER = 'GOOGLE_DRIVE_FOLDER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXPORT_DELIVERY_DESTINATION_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SLACK_CHANNEL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'slack_channel' then SLACK_CHANNEL
+      when 'google_drive_folder' then GOOGLE_DRIVE_FOLDER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/export_project_quality.rb

@@ -0,0 +1,44 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Vertical resolution tier for the rendered MP4.
+  class ExportProjectQuality
+    EXPORT_PROJECT_QUALITY = [
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for FULL_HIGH
+      FULL_HIGH = 'FULL_HIGH'.freeze,
+
+      # TODO: Write general description for ULTRA_HIGH
+      ULTRA_HIGH = 'ULTRA_HIGH'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXPORT_PROJECT_QUALITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = STANDARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'full_high' then FULL_HIGH
+      when 'ultra_high' then ULTRA_HIGH
+      else
+        default_value
+      end
+    end
+  end
+end