ilovevideoeditor-sdk 1.0.0

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

@@ -0,0 +1,409 @@
+=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 WorkflowRunStep < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :workflow_run_id
+
+    attr_accessor :step_index
+
+    attr_accessor :step_type
+
+    attr_accessor :name
+
+    attr_accessor :config
+
+    attr_accessor :status
+
+    attr_accessor :input_url
+
+    attr_accessor :output_url
+
+    attr_accessor :output_key
+
+    attr_accessor :rendition_id
+
+    attr_accessor :error
+
+    attr_accessor :response_status
+
+    attr_accessor :metadata
+
+    attr_accessor :retry_count
+
+    attr_accessor :max_retries
+
+    attr_accessor :logs
+
+    attr_accessor :started_at
+
+    attr_accessor :completed_at
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'workflow_run_id' => :'workflowRunId',
+        :'step_index' => :'stepIndex',
+        :'step_type' => :'stepType',
+        :'name' => :'name',
+        :'config' => :'config',
+        :'status' => :'status',
+        :'input_url' => :'inputUrl',
+        :'output_url' => :'outputUrl',
+        :'output_key' => :'outputKey',
+        :'rendition_id' => :'renditionId',
+        :'error' => :'error',
+        :'response_status' => :'responseStatus',
+        :'metadata' => :'metadata',
+        :'retry_count' => :'retryCount',
+        :'max_retries' => :'maxRetries',
+        :'logs' => :'logs',
+        :'started_at' => :'startedAt',
+        :'completed_at' => :'completedAt',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    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',
+        :'workflow_run_id' => :'String',
+        :'step_index' => :'Integer',
+        :'step_type' => :'String',
+        :'name' => :'String',
+        :'config' => :'Object',
+        :'status' => :'String',
+        :'input_url' => :'String',
+        :'output_url' => :'String',
+        :'output_key' => :'String',
+        :'rendition_id' => :'String',
+        :'error' => :'String',
+        :'response_status' => :'Integer',
+        :'metadata' => :'Object',
+        :'retry_count' => :'Integer',
+        :'max_retries' => :'Integer',
+        :'logs' => :'Array<Object>',
+        :'started_at' => :'Time',
+        :'completed_at' => :'Time',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'config',
+        :'input_url',
+        :'output_url',
+        :'output_key',
+        :'rendition_id',
+        :'error',
+        :'response_status',
+        :'metadata',
+        :'logs',
+        :'started_at',
+        :'completed_at',
+      ])
+    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::WorkflowRunStep` 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::WorkflowRunStep`. 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?(:'workflow_run_id')
+        self.workflow_run_id = attributes[:'workflow_run_id']
+      else
+        self.workflow_run_id = nil
+      end
+
+      if attributes.key?(:'step_index')
+        self.step_index = attributes[:'step_index']
+      else
+        self.step_index = nil
+      end
+
+      if attributes.key?(:'step_type')
+        self.step_type = attributes[:'step_type']
+      else
+        self.step_type = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'config')
+        self.config = attributes[:'config']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'input_url')
+        self.input_url = attributes[:'input_url']
+      end
+
+      if attributes.key?(:'output_url')
+        self.output_url = attributes[:'output_url']
+      end
+
+      if attributes.key?(:'output_key')
+        self.output_key = attributes[:'output_key']
+      end
+
+      if attributes.key?(:'rendition_id')
+        self.rendition_id = attributes[:'rendition_id']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'response_status')
+        self.response_status = attributes[:'response_status']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'retry_count')
+        self.retry_count = attributes[:'retry_count']
+      end
+
+      if attributes.key?(:'max_retries')
+        self.max_retries = attributes[:'max_retries']
+      end
+
+      if attributes.key?(:'logs')
+        if (value = attributes[:'logs']).is_a?(Array)
+          self.logs = value
+        end
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      end
+
+      if attributes.key?(:'completed_at')
+        self.completed_at = attributes[:'completed_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      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 @workflow_run_id.nil?
+        invalid_properties.push('invalid value for "workflow_run_id", workflow_run_id cannot be nil.')
+      end
+
+      if @step_index.nil?
+        invalid_properties.push('invalid value for "step_index", step_index cannot be nil.')
+      end
+
+      if @step_type.nil?
+        invalid_properties.push('invalid value for "step_type", step_type 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 @workflow_run_id.nil?
+      return false if @step_index.nil?
+      return false if @step_type.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] workflow_run_id Value to be assigned
+    def workflow_run_id=(workflow_run_id)
+      if workflow_run_id.nil?
+        fail ArgumentError, 'workflow_run_id cannot be nil'
+      end
+
+      @workflow_run_id = workflow_run_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] step_index Value to be assigned
+    def step_index=(step_index)
+      if step_index.nil?
+        fail ArgumentError, 'step_index cannot be nil'
+      end
+
+      @step_index = step_index
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] step_type Value to be assigned
+    def step_type=(step_type)
+      if step_type.nil?
+        fail ArgumentError, 'step_type cannot be nil'
+      end
+
+      @step_type = step_type
+    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 &&
+          workflow_run_id == o.workflow_run_id &&
+          step_index == o.step_index &&
+          step_type == o.step_type &&
+          name == o.name &&
+          config == o.config &&
+          status == o.status &&
+          input_url == o.input_url &&
+          output_url == o.output_url &&
+          output_key == o.output_key &&
+          rendition_id == o.rendition_id &&
+          error == o.error &&
+          response_status == o.response_status &&
+          metadata == o.metadata &&
+          retry_count == o.retry_count &&
+          max_retries == o.max_retries &&
+          logs == o.logs &&
+          started_at == o.started_at &&
+          completed_at == o.completed_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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, workflow_run_id, step_index, step_type, name, config, status, input_url, output_url, output_key, rendition_id, error, response_status, metadata, retry_count, max_retries, logs, started_at, completed_at, created_at, updated_at].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_step.rb

@@ -0,0 +1,262 @@
+=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 WorkflowStep < ApiModelBase
+    attr_accessor :type
+
+    attr_accessor :name
+
+    attr_accessor :max_retries
+
+    attr_accessor :config
+
+    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
+      {
+        :'type' => :'type',
+        :'name' => :'name',
+        :'max_retries' => :'maxRetries',
+        :'config' => :'config'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'name' => :'String',
+        :'max_retries' => :'Integer',
+        :'config' => :'Hash<String, Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::WorkflowStep` 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::WorkflowStep`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'max_retries')
+        self.max_retries = attributes[:'max_retries']
+      end
+
+      if attributes.key?(:'config')
+        if (value = attributes[:'config']).is_a?(Hash)
+          self.config = value
+        end
+      else
+        self.config = 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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if !@max_retries.nil? && @max_retries > 10
+        invalid_properties.push('invalid value for "max_retries", must be smaller than or equal to 10.')
+      end
+
+      if !@max_retries.nil? && @max_retries < 0
+        invalid_properties.push('invalid value for "max_retries", must be greater than or equal to 0.')
+      end
+
+      if @config.nil?
+        invalid_properties.push('invalid value for "config", config 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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["upload_asset", "crawl_url", "discover_variables", "render_template", "render_videojson", "apply_tool", "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
+      return false if @config.nil?
+      true
+    end
+
+    # 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"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_retries Value to be assigned
+    def max_retries=(max_retries)
+      if max_retries.nil?
+        fail ArgumentError, 'max_retries cannot be nil'
+      end
+
+      if max_retries > 10
+        fail ArgumentError, 'invalid value for "max_retries", must be smaller than or equal to 10.'
+      end
+
+      if max_retries < 0
+        fail ArgumentError, 'invalid value for "max_retries", must be greater than or equal to 0.'
+      end
+
+      @max_retries = max_retries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] config Value to be assigned
+    def config=(config)
+      if config.nil?
+        fail ArgumentError, 'config cannot be nil'
+      end
+
+      @config = config
+    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 &&
+          type == o.type &&
+          name == o.name &&
+          max_retries == o.max_retries &&
+          config == o.config
+    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
+      [type, name, max_retries, config].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