ilovevideoeditor-sdk 1.0.0

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

@@ -0,0 +1,357 @@
+=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
+  # JSON body POSTed to webhook targets on terminal render states.
+  class RenderWebhookPayload < ApiModelBase
+    attr_accessor :event
+
+    # Render job ID.
+    attr_accessor :id
+
+    attr_accessor :status
+
+    attr_accessor :stage
+
+    attr_accessor :progress
+
+    attr_accessor :url
+
+    attr_accessor :outputs
+
+    attr_accessor :duration
+
+    attr_accessor :width
+
+    attr_accessor :height
+
+    attr_accessor :template_id
+
+    attr_accessor :cost
+
+    attr_accessor :error
+
+    attr_accessor :created_at
+
+    attr_accessor :completed_at
+
+    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
+      {
+        :'event' => :'event',
+        :'id' => :'id',
+        :'status' => :'status',
+        :'stage' => :'stage',
+        :'progress' => :'progress',
+        :'url' => :'url',
+        :'outputs' => :'outputs',
+        :'duration' => :'duration',
+        :'width' => :'width',
+        :'height' => :'height',
+        :'template_id' => :'templateId',
+        :'cost' => :'cost',
+        :'error' => :'error',
+        :'created_at' => :'createdAt',
+        :'completed_at' => :'completedAt'
+      }
+    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
+      {
+        :'event' => :'String',
+        :'id' => :'String',
+        :'status' => :'String',
+        :'stage' => :'String',
+        :'progress' => :'Integer',
+        :'url' => :'String',
+        :'outputs' => :'Array<Hash<String, Object>>',
+        :'duration' => :'Float',
+        :'width' => :'Integer',
+        :'height' => :'Integer',
+        :'template_id' => :'String',
+        :'cost' => :'Float',
+        :'error' => :'String',
+        :'created_at' => :'Time',
+        :'completed_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'url',
+        :'error',
+        :'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::RenderWebhookPayload` 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::RenderWebhookPayload`. 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?(:'event')
+        self.event = attributes[:'event']
+      else
+        self.event = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'stage')
+        self.stage = attributes[:'stage']
+      end
+
+      if attributes.key?(:'progress')
+        self.progress = attributes[:'progress']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'outputs')
+        if (value = attributes[:'outputs']).is_a?(Array)
+          self.outputs = value
+        end
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'width')
+        self.width = attributes[:'width']
+      end
+
+      if attributes.key?(:'height')
+        self.height = attributes[:'height']
+      end
+
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'completed_at')
+        self.completed_at = attributes[:'completed_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 @event.nil?
+        invalid_properties.push('invalid value for "event", event cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @event.nil?
+      event_validator = EnumAttributeValidator.new('String', ["render.completed", "render.failed"])
+      return false unless event_validator.valid?(@event)
+      return false if @id.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["completed", "failed"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] event Object to be assigned
+    def event=(event)
+      validator = EnumAttributeValidator.new('String', ["render.completed", "render.failed"])
+      unless validator.valid?(event)
+        fail ArgumentError, "invalid value for \"event\", must be one of #{validator.allowable_values}."
+      end
+      @event = event
+    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 checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["completed", "failed"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          event == o.event &&
+          id == o.id &&
+          status == o.status &&
+          stage == o.stage &&
+          progress == o.progress &&
+          url == o.url &&
+          outputs == o.outputs &&
+          duration == o.duration &&
+          width == o.width &&
+          height == o.height &&
+          template_id == o.template_id &&
+          cost == o.cost &&
+          error == o.error &&
+          created_at == o.created_at &&
+          completed_at == o.completed_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
+      [event, id, status, stage, progress, url, outputs, duration, width, height, template_id, cost, error, created_at, completed_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/rendition.rb

@@ -0,0 +1,335 @@
+=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 Rendition < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :job_id
+
+    attr_accessor :project_id
+
+    attr_accessor :status
+
+    attr_accessor :stage
+
+    attr_accessor :cost
+
+    attr_accessor :duration
+
+    attr_accessor :width
+
+    attr_accessor :height
+
+    attr_accessor :fps
+
+    attr_accessor :output_url
+
+    attr_accessor :output_size_bytes
+
+    attr_accessor :error
+
+    attr_accessor :progress_percent
+
+    attr_accessor :sprite_url
+
+    attr_accessor :video_json
+
+    attr_accessor :outputs
+
+    attr_accessor :projects
+
+    attr_accessor :created_at
+
+    attr_accessor :completed_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'job_id' => :'job_id',
+        :'project_id' => :'project_id',
+        :'status' => :'status',
+        :'stage' => :'stage',
+        :'cost' => :'cost',
+        :'duration' => :'duration',
+        :'width' => :'width',
+        :'height' => :'height',
+        :'fps' => :'fps',
+        :'output_url' => :'output_url',
+        :'output_size_bytes' => :'output_size_bytes',
+        :'error' => :'error',
+        :'progress_percent' => :'progress_percent',
+        :'sprite_url' => :'sprite_url',
+        :'video_json' => :'video_json',
+        :'outputs' => :'outputs',
+        :'projects' => :'projects',
+        :'created_at' => :'created_at',
+        :'completed_at' => :'completed_at'
+      }
+    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',
+        :'job_id' => :'String',
+        :'project_id' => :'String',
+        :'status' => :'String',
+        :'stage' => :'String',
+        :'cost' => :'Float',
+        :'duration' => :'Float',
+        :'width' => :'Integer',
+        :'height' => :'Integer',
+        :'fps' => :'Integer',
+        :'output_url' => :'String',
+        :'output_size_bytes' => :'Integer',
+        :'error' => :'String',
+        :'progress_percent' => :'Integer',
+        :'sprite_url' => :'String',
+        :'video_json' => :'Object',
+        :'outputs' => :'Array<RenditionOutput>',
+        :'projects' => :'Object',
+        :'created_at' => :'Time',
+        :'completed_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'job_id',
+        :'project_id',
+        :'cost',
+        :'duration',
+        :'width',
+        :'height',
+        :'fps',
+        :'output_url',
+        :'output_size_bytes',
+        :'error',
+        :'progress_percent',
+        :'sprite_url',
+        :'video_json',
+        :'projects',
+        :'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::Rendition` 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::Rendition`. 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']
+      end
+
+      if attributes.key?(:'job_id')
+        self.job_id = attributes[:'job_id']
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'stage')
+        self.stage = attributes[:'stage']
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'width')
+        self.width = attributes[:'width']
+      end
+
+      if attributes.key?(:'height')
+        self.height = attributes[:'height']
+      end
+
+      if attributes.key?(:'fps')
+        self.fps = attributes[:'fps']
+      end
+
+      if attributes.key?(:'output_url')
+        self.output_url = attributes[:'output_url']
+      end
+
+      if attributes.key?(:'output_size_bytes')
+        self.output_size_bytes = attributes[:'output_size_bytes']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'progress_percent')
+        self.progress_percent = attributes[:'progress_percent']
+      end
+
+      if attributes.key?(:'sprite_url')
+        self.sprite_url = attributes[:'sprite_url']
+      end
+
+      if attributes.key?(:'video_json')
+        self.video_json = attributes[:'video_json']
+      end
+
+      if attributes.key?(:'outputs')
+        if (value = attributes[:'outputs']).is_a?(Array)
+          self.outputs = value
+        end
+      end
+
+      if attributes.key?(:'projects')
+        self.projects = attributes[:'projects']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'completed_at')
+        self.completed_at = attributes[:'completed_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
+      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'
+      true
+    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 &&
+          job_id == o.job_id &&
+          project_id == o.project_id &&
+          status == o.status &&
+          stage == o.stage &&
+          cost == o.cost &&
+          duration == o.duration &&
+          width == o.width &&
+          height == o.height &&
+          fps == o.fps &&
+          output_url == o.output_url &&
+          output_size_bytes == o.output_size_bytes &&
+          error == o.error &&
+          progress_percent == o.progress_percent &&
+          sprite_url == o.sprite_url &&
+          video_json == o.video_json &&
+          outputs == o.outputs &&
+          projects == o.projects &&
+          created_at == o.created_at &&
+          completed_at == o.completed_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, job_id, project_id, status, stage, cost, duration, width, height, fps, output_url, output_size_bytes, error, progress_percent, sprite_url, video_json, outputs, projects, created_at, completed_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