ilovevideoeditor-sdk 1.0.0 → 1.0.2

data/lib/generated/ilovevideoeditor-sdk/models/workflow_preset.rb

@@ -0,0 +1,417 @@
+=begin
+#iLoveVideoEditor API
+
+#Cloud video rendering API for iLoveVideoEditor. Submit a `VideoJSON` payload, queue a render job, and download the resulting MP4.  **Authentication** - **API Key** (`x-api-key` header) — accepted by render pipeline and tool endpoints. - **Bearer Token** (`Authorization: Bearer <jwt>`) — required for user-scoped project, asset, billing, and webhook endpoints. - Many endpoints accept either form of authentication.  **SDKs** Official typed SDKs are available for JavaScript/TypeScript, PHP, Python, Ruby, and Go. See https://ilovevideoeditor.com/docs/sdks  **Outbound Webhooks** Render lifecycle events (`render.completed`, `render.failed`) are delivered to your endpoints as signed HTTP POST requests. See the `Webhooks` tag and the root-level `x-webhook-docs` extension for the payload format (`RenderWebhookPayload`), signature headers, HMAC verification, and the retry policy.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ILoveVideoEditor
+  class WorkflowPreset < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :description
+
+    attr_accessor :category
+
+    # Onboarding roles this preset is recommended for.
+    attr_accessor :roles
+
+    # Onboarding goals this preset is recommended for.
+    attr_accessor :goals
+
+    # Onboarding channels this preset is recommended for.
+    attr_accessor :channels
+
+    # Toolkit template id whose poster image represents this preset.
+    attr_accessor :poster_template_id
+
+    # Approximate credits consumed per run.
+    attr_accessor :estimated_credits
+
+    attr_accessor :definition
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'description' => :'description',
+        :'category' => :'category',
+        :'roles' => :'roles',
+        :'goals' => :'goals',
+        :'channels' => :'channels',
+        :'poster_template_id' => :'posterTemplateId',
+        :'estimated_credits' => :'estimatedCredits',
+        :'definition' => :'definition'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'category' => :'String',
+        :'roles' => :'Array<String>',
+        :'goals' => :'Array<String>',
+        :'channels' => :'Array<String>',
+        :'poster_template_id' => :'String',
+        :'estimated_credits' => :'Integer',
+        :'definition' => :'WorkflowDefinition'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'poster_template_id',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ILoveVideoEditor::WorkflowPreset` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ILoveVideoEditor::WorkflowPreset`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'category')
+        self.category = attributes[:'category']
+      else
+        self.category = nil
+      end
+
+      if attributes.key?(:'roles')
+        if (value = attributes[:'roles']).is_a?(Array)
+          self.roles = value
+        end
+      else
+        self.roles = nil
+      end
+
+      if attributes.key?(:'goals')
+        if (value = attributes[:'goals']).is_a?(Array)
+          self.goals = value
+        end
+      else
+        self.goals = nil
+      end
+
+      if attributes.key?(:'channels')
+        if (value = attributes[:'channels']).is_a?(Array)
+          self.channels = value
+        end
+      else
+        self.channels = nil
+      end
+
+      if attributes.key?(:'poster_template_id')
+        self.poster_template_id = attributes[:'poster_template_id']
+      end
+
+      if attributes.key?(:'estimated_credits')
+        self.estimated_credits = attributes[:'estimated_credits']
+      else
+        self.estimated_credits = nil
+      end
+
+      if attributes.key?(:'definition')
+        self.definition = attributes[:'definition']
+      else
+        self.definition = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @category.nil?
+        invalid_properties.push('invalid value for "category", category cannot be nil.')
+      end
+
+      if @roles.nil?
+        invalid_properties.push('invalid value for "roles", roles cannot be nil.')
+      end
+
+      if @goals.nil?
+        invalid_properties.push('invalid value for "goals", goals cannot be nil.')
+      end
+
+      if @channels.nil?
+        invalid_properties.push('invalid value for "channels", channels cannot be nil.')
+      end
+
+      if @estimated_credits.nil?
+        invalid_properties.push('invalid value for "estimated_credits", estimated_credits cannot be nil.')
+      end
+
+      if @definition.nil?
+        invalid_properties.push('invalid value for "definition", definition cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @name.nil?
+      return false if @description.nil?
+      return false if @category.nil?
+      category_validator = EnumAttributeValidator.new('String', ["getting-started", "social", "promo", "real_estate", "travel", "events", "news", "beauty", "automotive", "business"])
+      return false unless category_validator.valid?(@category)
+      return false if @roles.nil?
+      return false if @goals.nil?
+      return false if @channels.nil?
+      return false if @estimated_credits.nil?
+      return false if @definition.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] category Object to be assigned
+    def category=(category)
+      validator = EnumAttributeValidator.new('String', ["getting-started", "social", "promo", "real_estate", "travel", "events", "news", "beauty", "automotive", "business"])
+      unless validator.valid?(category)
+        fail ArgumentError, "invalid value for \"category\", must be one of #{validator.allowable_values}."
+      end
+      @category = category
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] roles Value to be assigned
+    def roles=(roles)
+      if roles.nil?
+        fail ArgumentError, 'roles cannot be nil'
+      end
+
+      @roles = roles
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] goals Value to be assigned
+    def goals=(goals)
+      if goals.nil?
+        fail ArgumentError, 'goals cannot be nil'
+      end
+
+      @goals = goals
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] channels Value to be assigned
+    def channels=(channels)
+      if channels.nil?
+        fail ArgumentError, 'channels cannot be nil'
+      end
+
+      @channels = channels
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] estimated_credits Value to be assigned
+    def estimated_credits=(estimated_credits)
+      if estimated_credits.nil?
+        fail ArgumentError, 'estimated_credits cannot be nil'
+      end
+
+      @estimated_credits = estimated_credits
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] definition Value to be assigned
+    def definition=(definition)
+      if definition.nil?
+        fail ArgumentError, 'definition cannot be nil'
+      end
+
+      @definition = definition
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name &&
+          description == o.description &&
+          category == o.category &&
+          roles == o.roles &&
+          goals == o.goals &&
+          channels == o.channels &&
+          poster_template_id == o.poster_template_id &&
+          estimated_credits == o.estimated_credits &&
+          definition == o.definition
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, name, description, category, roles, goals, channels, poster_template_id, estimated_credits, definition].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/generated/ilovevideoeditor-sdk/models/workflow_run.rb

@@ -25,6 +25,7 @@ module ILoveVideoEditor
 
     attr_accessor :trigger
 
+    # `queued` → `running` → `completed` / `failed` / `cancelled`. A run with a human-in-the-loop `review` step pauses in `waiting_review` until the step is approved or rejected via `/v1/workflows/runs/{runId}/steps/{stepId}/review`.
     attr_accessor :status
 
     attr_accessor :variables

data/lib/generated/ilovevideoeditor-sdk/models/workflow_run_step.rb

@@ -27,6 +27,7 @@ module ILoveVideoEditor
 
     attr_accessor :config
 
+    # `pending` → `running` → `completed` / `failed` / `skipped`. A `review` step waits in `waiting` for a human decision; the run is in `waiting_review` while any step is waiting.
     attr_accessor :status
 
     attr_accessor :input_url

data/lib/generated/ilovevideoeditor-sdk/models/workflow_step.rb

@@ -149,7 +149,7 @@ module ILoveVideoEditor
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["upload_asset", "crawl_url", "discover_variables", "render_template", "render_videojson", "apply_tool", "send_to_destination"])
+      type_validator = EnumAttributeValidator.new('String', ["upload_asset", "crawl_url", "discover_variables", "render_template", "render_videojson", "apply_tool", "review", "send_to_destination"])
       return false unless type_validator.valid?(@type)
       return false if !@max_retries.nil? && @max_retries > 10
       return false if !@max_retries.nil? && @max_retries < 0
@@ -160,7 +160,7 @@ module ILoveVideoEditor
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["upload_asset", "crawl_url", "discover_variables", "render_template", "render_videojson", "apply_tool", "send_to_destination"])
+      validator = EnumAttributeValidator.new('String', ["upload_asset", "crawl_url", "discover_variables", "render_template", "render_videojson", "apply_tool", "review", "send_to_destination"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/generated/ilovevideoeditor-sdk.rb

@@ -56,6 +56,7 @@ require 'ilovevideoeditor-sdk/models/get_subscription200_response'
 require 'ilovevideoeditor-sdk/models/get_template200_response'
 require 'ilovevideoeditor-sdk/models/get_usage200_response'
 require 'ilovevideoeditor-sdk/models/get_workflow200_response'
+require 'ilovevideoeditor-sdk/models/get_workflow_preset200_response'
 require 'ilovevideoeditor-sdk/models/get_workflow_run200_response'
 require 'ilovevideoeditor-sdk/models/health_check200_response'
 require 'ilovevideoeditor-sdk/models/health_check_detailed200_response'
@@ -68,6 +69,7 @@ require 'ilovevideoeditor-sdk/models/list_projects200_response'
 require 'ilovevideoeditor-sdk/models/list_renditions200_response'
 require 'ilovevideoeditor-sdk/models/list_templates200_response'
 require 'ilovevideoeditor-sdk/models/list_webhook_subscriptions200_response'
+require 'ilovevideoeditor-sdk/models/list_workflow_presets200_response'
 require 'ilovevideoeditor-sdk/models/list_workflow_runs200_response'
 require 'ilovevideoeditor-sdk/models/list_workflow_step_types200_response'
 require 'ilovevideoeditor-sdk/models/list_workflows200_response'
@@ -89,6 +91,7 @@ require 'ilovevideoeditor-sdk/models/rendition'
 require 'ilovevideoeditor-sdk/models/rendition_cancel_result'
 require 'ilovevideoeditor-sdk/models/rendition_output'
 require 'ilovevideoeditor-sdk/models/rendition_stats'
+require 'ilovevideoeditor-sdk/models/review_workflow_step_request'
 require 'ilovevideoeditor-sdk/models/run_workflow202_response'
 require 'ilovevideoeditor-sdk/models/run_workflow_request'
 require 'ilovevideoeditor-sdk/models/service_health'
@@ -110,6 +113,7 @@ require 'ilovevideoeditor-sdk/models/webhook_subscription'
 require 'ilovevideoeditor-sdk/models/webhook_subscription_create'
 require 'ilovevideoeditor-sdk/models/workflow'
 require 'ilovevideoeditor-sdk/models/workflow_definition'
+require 'ilovevideoeditor-sdk/models/workflow_preset'
 require 'ilovevideoeditor-sdk/models/workflow_run'
 require 'ilovevideoeditor-sdk/models/workflow_run_step'
 require 'ilovevideoeditor-sdk/models/workflow_step'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ilovevideoeditor-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - iLoveVideoEditor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-14 00:00:00.000000000 Z
+date: 2026-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -30,7 +30,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
-description: High-level wrapper over the auto-generated iLoveVideoEditor OpenAPI client
+description: 'Render videos programmatically with the iLoveVideoEditor cloud video
+  API: submit JSON scenes or render templates with variables, queue render jobs, and
+  download the resulting MP4/WebM. Provides a high-level client with blocking renders,
+  polling and progress callbacks, plus the full auto-generated OpenAPI client for
+  every endpoint. Requires Ruby 3.0 or later.'
 email: support@ilovevideoeditor.com
 executables: []
 extensions: []
@@ -91,6 +95,7 @@ files:
 - lib/generated/ilovevideoeditor-sdk/models/get_template200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/get_usage200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/get_workflow200_response.rb
+- lib/generated/ilovevideoeditor-sdk/models/get_workflow_preset200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/get_workflow_run200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/health_check200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/health_check_detailed200_response.rb
@@ -103,6 +108,7 @@ files:
 - lib/generated/ilovevideoeditor-sdk/models/list_renditions200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/list_templates200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/list_webhook_subscriptions200_response.rb
+- lib/generated/ilovevideoeditor-sdk/models/list_workflow_presets200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/list_workflow_runs200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/list_workflow_step_types200_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/list_workflows200_response.rb
@@ -124,6 +130,7 @@ files:
 - lib/generated/ilovevideoeditor-sdk/models/rendition_cancel_result.rb
 - lib/generated/ilovevideoeditor-sdk/models/rendition_output.rb
 - lib/generated/ilovevideoeditor-sdk/models/rendition_stats.rb
+- lib/generated/ilovevideoeditor-sdk/models/review_workflow_step_request.rb
 - lib/generated/ilovevideoeditor-sdk/models/run_workflow202_response.rb
 - lib/generated/ilovevideoeditor-sdk/models/run_workflow_request.rb
 - lib/generated/ilovevideoeditor-sdk/models/service_health.rb
@@ -145,6 +152,7 @@ files:
 - lib/generated/ilovevideoeditor-sdk/models/webhook_subscription_create.rb
 - lib/generated/ilovevideoeditor-sdk/models/workflow.rb
 - lib/generated/ilovevideoeditor-sdk/models/workflow_definition.rb
+- lib/generated/ilovevideoeditor-sdk/models/workflow_preset.rb
 - lib/generated/ilovevideoeditor-sdk/models/workflow_run.rb
 - lib/generated/ilovevideoeditor-sdk/models/workflow_run_step.rb
 - lib/generated/ilovevideoeditor-sdk/models/workflow_step.rb
@@ -154,10 +162,15 @@ files:
 - lib/generated/ilovevideoeditor-sdk/version.rb
 - lib/ilovevideoeditor-sdk.rb
 - lib/ilovevideoeditor/client.rb
-homepage: https://ilovevideoeditor.com
+homepage: https://ilovevideoeditor.com/docs/sdks
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://ilovevideoeditor.com
+  source_code_uri: https://github.com/ilovevideoeditor/sdk-ruby
+  documentation_uri: https://ilovevideoeditor.com/docs
+  changelog_uri: https://github.com/ilovevideoeditor/sdk-ruby/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/ilovevideoeditor/sdk-ruby/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -177,5 +190,5 @@ requirements: []
 rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: Official Ruby SDK for iLoveVideoEditor
+summary: Official Ruby SDK for the iLoveVideoEditor cloud video rendering API
 test_files: []