shotstack 0.0.10 → 0.1.3

data/lib/shotstack/models/render_response.rb

@@ -1,12 +1,12 @@
 =begin
-#shotstack
+#Shotstack
 
-#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
@@ -14,8 +14,10 @@ require 'date'
 
 module Shotstack
   class RenderResponse
+    # `true` if status available, else `false`.
     attr_accessor :success
 
+    # `OK` or an error message.
     attr_accessor :message
 
     attr_accessor :response
@@ -38,6 +40,12 @@ module Shotstack
       }
     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 = {})
@@ -202,7 +210,11 @@ module Shotstack
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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

data/lib/shotstack/models/render_response_data.rb

@@ -1,12 +1,12 @@
 =begin
-#shotstack
+#Shotstack
 
-#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
@@ -14,21 +14,42 @@ require 'date'
 
 module Shotstack
   class RenderResponseData
-    # The status of the render task
-    attr_accessor :status
-
-    # The id of the render task in UUID format
+    # The id of the render task in UUID format.
     attr_accessor :id
 
-    # The owner id of the render task
+    # The owner id of the render task.
     attr_accessor :owner
 
+    # The customer subscription plan.
+    attr_accessor :plan
+
+    # The status of the render task. <ul>   <li>`queued` - render is queued waiting to be rendered</li>   <li>`fetching` - assets are being fetched</li>   <li>`rendering` - the video is being rendered</li>   <li>`saving` - the final video is being saved to storage</li>   <li>`done` - the video is ready to be downloaded</li>   <li>`failed` - there was an error rendering the video</li> </ul>
+    attr_accessor :status
+
+    # An error message, only displayed if an error occurred.
+    attr_accessor :error
+
+    # The output video length in seconds.
+    attr_accessor :duration
+
+    # The time taken to render the video in milliseconds.
+    attr_accessor :render_time
+
+    # The URL of the final video. This will only be available if status is done.
+    attr_accessor :url
+
+    # The URL of the poster image if requested. This will only be available if status is done.
+    attr_accessor :poster
+
+    # The URL of the thumbnail image if requested. This will only be available if status is done.
+    attr_accessor :thumbnail
+
     attr_accessor :data
 
-    # The time the render task was initially queued
+    # The time the render task was initially queued.
     attr_accessor :created
 
-    # The time the render status was last updated
+    # The time the render status was last updated.
     attr_accessor :updated
 
     class EnumAttributeValidator
@@ -56,9 +77,16 @@ module Shotstack
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'status' => :'status',
         :'id' => :'id',
         :'owner' => :'owner',
+        :'plan' => :'plan',
+        :'status' => :'status',
+        :'error' => :'error',
+        :'duration' => :'duration',
+        :'render_time' => :'renderTime',
+        :'url' => :'url',
+        :'poster' => :'poster',
+        :'thumbnail' => :'thumbnail',
         :'data' => :'data',
         :'created' => :'created',
         :'updated' => :'updated'
@@ -68,15 +96,28 @@ module Shotstack
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'status' => :'String',
         :'id' => :'String',
         :'owner' => :'String',
+        :'plan' => :'String',
+        :'status' => :'String',
+        :'error' => :'String',
+        :'duration' => :'Float',
+        :'render_time' => :'Float',
+        :'url' => :'String',
+        :'poster' => :'String',
+        :'thumbnail' => :'String',
         :'data' => :'Edit',
         :'created' => :'String',
         :'updated' => :'String'
       }
     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 = {})
@@ -92,10 +133,6 @@ module Shotstack
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
-      end
-
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -104,6 +141,38 @@ module Shotstack
         self.owner = attributes[:'owner']
       end
 
+      if attributes.key?(:'plan')
+        self.plan = attributes[:'plan']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'render_time')
+        self.render_time = attributes[:'render_time']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'poster')
+        self.poster = attributes[:'poster']
+      end
+
+      if attributes.key?(:'thumbnail')
+        self.thumbnail = attributes[:'thumbnail']
+      end
+
       if attributes.key?(:'data')
         self.data = attributes[:'data']
       end
@@ -121,10 +190,6 @@ module Shotstack
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @status.nil?
-        invalid_properties.push('invalid value for "status", status cannot be nil.')
-      end
-
       if @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
@@ -133,6 +198,10 @@ module Shotstack
         invalid_properties.push('invalid value for "owner", owner cannot be nil.')
       end
 
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
       if @data.nil?
         invalid_properties.push('invalid value for "data", data cannot be nil.')
       end
@@ -151,11 +220,11 @@ module Shotstack
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @id.nil?
+      return false if @owner.nil?
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["queued", "fetching", "rendering", "saving", "done", "failed"])
       return false unless status_validator.valid?(@status)
-      return false if @id.nil?
-      return false if @owner.nil?
       return false if @data.nil?
       return false if @created.nil?
       return false if @updated.nil?
@@ -177,9 +246,16 @@ module Shotstack
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          status == o.status &&
           id == o.id &&
           owner == o.owner &&
+          plan == o.plan &&
+          status == o.status &&
+          error == o.error &&
+          duration == o.duration &&
+          render_time == o.render_time &&
+          url == o.url &&
+          poster == o.poster &&
+          thumbnail == o.thumbnail &&
           data == o.data &&
           created == o.created &&
           updated == o.updated
@@ -194,7 +270,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, id, owner, data, created, updated].hash
+      [id, owner, plan, status, error, duration, render_time, url, poster, thumbnail, data, created, updated].hash
     end
 
     # Builds the object from hash
@@ -283,7 +359,11 @@ module Shotstack
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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

data/lib/shotstack/models/soundtrack.rb

@@ -1,31 +1,57 @@
 =begin
-#shotstack
+#Shotstack
 
-#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
 require 'date'
 
 module Shotstack
-  # A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest. 
+  # A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
   class Soundtrack
-    # The URL of the mp3 audio file. The URL must be publicly accessible or include credentials. 
+    # The URL of the mp3 audio file. The URL must be publicly accessible or include credentials.
     attr_accessor :src
 
-    # The effect to apply to the audio file
+    # The effect to apply to the audio file <ul>   <li>`fadeIn` - fade volume in only</li>   <li>`fadeOut` - fade volume out only</li>   <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
     attr_accessor :effect
 
+    # Set the volume for the soundtrack between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
+    attr_accessor :volume
+
+    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
       {
         :'src' => :'src',
-        :'effect' => :'effect'
+        :'effect' => :'effect',
+        :'volume' => :'volume'
       }
     end
 
@@ -33,10 +59,17 @@ module Shotstack
     def self.openapi_types
       {
         :'src' => :'String',
-        :'effect' => :'String'
+        :'effect' => :'String',
+        :'volume' => :'Float'
       }
     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 = {})
@@ -59,6 +92,12 @@ module Shotstack
       if attributes.key?(:'effect')
         self.effect = attributes[:'effect']
       end
+
+      if attributes.key?(:'volume')
+        self.volume = attributes[:'volume']
+      else
+        self.volume = 1
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -69,10 +108,6 @@ module Shotstack
         invalid_properties.push('invalid value for "src", src cannot be nil.')
       end
 
-      if @effect.nil?
-        invalid_properties.push('invalid value for "effect", effect cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -80,17 +115,29 @@ module Shotstack
     # @return true if the model is valid
     def valid?
       return false if @src.nil?
-      return false if @effect.nil?
+      effect_validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeOut", "fadeInFadeOut"])
+      return false unless effect_validator.valid?(@effect)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] effect Object to be assigned
+    def effect=(effect)
+      validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeOut", "fadeInFadeOut"])
+      unless validator.valid?(effect)
+        fail ArgumentError, "invalid value for \"effect\", must be one of #{validator.allowable_values}."
+      end
+      @effect = effect
+    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 &&
           src == o.src &&
-          effect == o.effect
+          effect == o.effect &&
+          volume == o.volume
     end
 
     # @see the `==` method
@@ -102,7 +149,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [src, effect].hash
+      [src, effect, volume].hash
     end
 
     # Builds the object from hash
@@ -191,7 +238,11 @@ module Shotstack
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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

data/lib/shotstack/models/thumbnail.rb

@@ -0,0 +1,228 @@
+=begin
+#Shotstack
+
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.1
+
+=end
+
+require 'date'
+
+module Shotstack
+  # Generate a thumbnail image for the video at a specific point from the timeline.
+  class Thumbnail
+    # The point on the timeline in seconds to capture a single frame to use as the thumbnail image.
+    attr_accessor :capture
+
+    # Scale the thumbnail size to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale  the thumbnail to half the size of the viewport.
+    attr_accessor :scale
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'capture' => :'capture',
+        :'scale' => :'scale'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'capture' => :'Float',
+        :'scale' => :'Float'
+      }
+    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 `Shotstack::Thumbnail` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Shotstack::Thumbnail`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'capture')
+        self.capture = attributes[:'capture']
+      end
+
+      if attributes.key?(:'scale')
+        self.scale = attributes[:'scale']
+      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
+      invalid_properties = Array.new
+      if @capture.nil?
+        invalid_properties.push('invalid value for "capture", capture cannot be nil.')
+      end
+
+      if @scale.nil?
+        invalid_properties.push('invalid value for "scale", scale 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?
+      return false if @capture.nil?
+      return false if @scale.nil?
+      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 &&
+          capture == o.capture &&
+          scale == o.scale
+    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
+      [capture, scale].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Shotstack.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end